1157530 - [Build] Add a script to build and deploy apps to GitHub Pages

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::Build, defect, P1)

Description

[Doug Sherk (:drs) (inactive)]

As a workaround until we support remotely hosted apps in the Gaia build, we have to pull in pre-built apps using the 'repo' tool. The pre-built versions will live on each app's gh-pages repo. Let's add some Git hooks to trigger builds on pre-commit and pushes to gh-pages on pre-push.

Comment 1

[Doug Sherk (:drs) (inactive)]

Attachment: [Build] Include post-commit and pre-push hooks.

Comment 2

[Doug Sherk (:drs) (inactive)]

Attachment: [Sharing] Include dist folder in repo, build when committing, and push to gh-pages on push.

Comment 3

[Doug Sherk (:drs) (inactive)]

Attachment: [Hackerplace] Include dist folder in repo, build when committing, and push to gh-pages on push.

Comment 4

[Doug Sherk (:drs) (inactive)]

Attachment: Include dist folder in repo, build when committing, and push to gh-pages on push.

Comment 5

[Doug Sherk (:drs) (inactive)]

Kevin, could you also add me as an owner of the fxos-build npm package, and provide a quick runthrough of everything I have to do to update the package on npm?

Comment 6

[Doug Sherk (:drs) (inactive)]

Kevin, could you also add me as an owner of the fxos-build npm package, and provide a quick runthrough of everything I have to do to update the package on npm? My username is "drs".

Comment 7

[Kevin Grandon :kgrandon]

Hmm, I've recently done something similar in another pet project of mine, and wanted to avoid the churn of dist. To do that, I implemented a script like this: https://github.com/KevinGrandon/browser/blob/44afa4203112c4ae9c584fc392a87e725809d1c4/deploy.sh

To run it, I just run "./deploy.sh". What do you think of doing an approach like that Doug?

Comment 8

[Kevin Grandon :kgrandon]

(In reply to Doug Sherk (:drs) (use needinfo?) from comment #6)
> Kevin, could you also add me as an owner of the fxos-build npm package, and
> provide a quick runthrough of everything I have to do to update the package
> on npm? My username is "drs".

I've added you to the npm package.

Comment 9

[Doug Sherk (:drs) (inactive)]

(In reply to Kevin Grandon :kgrandon from comment #7)
> Hmm, I've recently done something similar in another pet project of mine,
> and wanted to avoid the churn of dist. To do that, I implemented a script
> like this:
> https://github.com/KevinGrandon/browser/blob/
> 44afa4203112c4ae9c584fc392a87e725809d1c4/deploy.sh
> 
> To run it, I just run "./deploy.sh". What do you think of doing an approach
> like that Doug?

This is pretty easy to forget, and I could see us running into many problems if we're not forcing people to rebuild when they commit. I don't think that we could easily turn this script into a commit hook, but maybe I'm wrong?

Also, each app has a slightly different build process, so we'd have to have a script for each app.

Comment 10

[Kevin Grandon :kgrandon]

Hmm, I don't think running a deploy.sh script is too bad, same thing we need to do for npm packages or bower tags really.

I'll take a look at this soon, I'm concerned about workflow with branches and pull requests - but maybe you have that covered.

Comment 11

[Michael Henretty [:mikehenrty][:mhenretty]]

One problem I think we'll run into with this approach is the launch_path for the manifest. For github pages, we need something relative like './index.html' or '/appname/dist/app/index.html', but this makes the manifest invalid (see bug 1119050), or not debuggable using webIDE in the second case. We should probably push to have bug 1119050 here since it's obsolete anyway, which needs bug 1108570.

I don't like that we are removing the automatic lint checking by default and requiring each app to specify it's own pre-commit hook. Is that just because some apps need apm and others don't?

Also, what happens if the pre-commit hook modifies dist? It seems we don't ensure this will get staged/committed and ultimately pushed to gh-pages?

Comment 12

[Doug Sherk (:drs) (inactive)]

(In reply to Kevin Grandon :kgrandon from comment #10)
> Hmm, I don't think running a deploy.sh script is too bad, same thing we need
> to do for npm packages or bower tags really.
> 
> I'll take a look at this soon, I'm concerned about workflow with branches
> and pull requests - but maybe you have that covered.

Yeah, I agree, this doesn't handle those cases. I'll switch to using a deploy script.

(In reply to Michael Henretty [:mhenretty] from comment #11)
> One problem I think we'll run into with this approach is the launch_path for
> the manifest. For github pages, we need something relative like
> './index.html' or '/appname/dist/app/index.html', but this makes the
> manifest invalid (see bug 1119050), or not debuggable using webIDE in the
> second case. We should probably push to have bug 1119050 here since it's
> obsolete anyway, which needs bug 1108570.

We requested a fxosapps.org domain for doing app.fxosapps.org -> fxos.github.io/app redirects.

> I don't like that we are removing the automatic lint checking by default and
> requiring each app to specify it's own pre-commit hook. Is that just because
> some apps need apm and others don't?

Yes, and the Customizer's 'custombuild' script.

Comment 13

[Kevin Grandon :kgrandon]

I wonder if we could have a 'npm run build' script as a convention that built each app? Individual apps could hook into it via package.json to do whatever additional steps they need to do? Thoughts?

Comment 14

[Kevin Grandon :kgrandon]

Comment on attachment 8596284 [details] [review]
[Build] Include post-commit and pre-push hooks.

Seems like the approach is changing, so clearing flag for now. Re-flag me when ready, thanks.

Comment 15

[Doug Sherk (:drs) (inactive)]

Attachment: [Build] Add a script to build and deploy apps to GitHub pages.

Comment 16

[Doug Sherk (:drs) (inactive)]

Attachment: [Sharing] Add an |npm run build| command and update fxos-build dependency.

Comment 17

[Doug Sherk (:drs) (inactive)]

Attachment: [Customizer] Add an |npm run build| command and update fxos-build dependency.

Comment 18

[Doug Sherk (:drs) (inactive)]

Attachment: [Hackerplace] Add an |npm run build| command and update fxos-build dependency.

Comment 19

[Justin D'Arcangelo [:justindarc]]

Comment on attachment 8596639 [details] [review]
[Sharing] Add an |npm run build| command and update fxos-build dependency.

LGTM

Comment 20

[Justin D'Arcangelo [:justindarc]]

Comment on attachment 8596640 [details] [review]
[Customizer] Add an |npm run build| command and update fxos-build dependency.

LGTM

Comment 21

[Kevin Grandon :kgrandon]

Comment on attachment 8596638 [details] [review]
[Build] Add a script to build and deploy apps to GitHub pages.

Hot stuff. Thanks!

Comment 22

[Michael Henretty [:mikehenrty][:mhenretty]]

Comment on attachment 8596645 [details] [review]
[Hackerplace] Add an |npm run build| command and update fxos-build dependency.

Like it.

Comment 23

[Doug Sherk (:drs) (inactive)]

Comment on attachment 8596638 [details] [review]
[Build] Add a script to build and deploy apps to GitHub pages.

https://github.com/fxos/build/commit/8c434cd188ea575eb6eab97f70502489b280fb5f

Comment 24

[Doug Sherk (:drs) (inactive)]

Comment on attachment 8596645 [details] [review]
[Hackerplace] Add an |npm run build| command and update fxos-build dependency.

https://github.com/fxos/directory/commit/4223eec70f2ec128832343cb1d0e517575f624bd

Comment 25

[Doug Sherk (:drs) (inactive)]

Comment on attachment 8596639 [details] [review]
[Sharing] Add an |npm run build| command and update fxos-build dependency.

https://github.com/fxos/sharing/commit/ce4775760cd92715b1e825d1dd5ee2c830eb900a

Comment 26

[Doug Sherk (:drs) (inactive)]

Comment on attachment 8596640 [details] [review]
[Customizer] Add an |npm run build| command and update fxos-build dependency.

https://github.com/fxos/customizer/commit/369a08777cbfa6dbf922542b59d381d06576826d

Comment 27

[Doug Sherk (:drs) (inactive)]

Re-opening this since we need the same changes to the Achievements app. [1] Yura, could you take this?

[1] https://github.com/fxos/achievements

Comment 28

[Yura Zenevich [:yzen] (please use "needinfo")]

https://github.com/fxos/achievements/commit/3092738b4c8f6ec39ee3e6b32292469f6d6675fb