Add new github docs folder hosting option #520

andyeskridge · 2016-08-31T04:13:46Z

This pull request fixes #501

The pull request adds instructions to the template readme and also adds a sequence of commands to the npm run build output.

I am happy to hear suggestions for making this better. I am wondering if the output after running npm run build is getting a little too long after adding this option. Maybe it would be good to settle on one option that we support for GH Pages?

ghost · 2016-08-31T04:14:37Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla - and if you have received this in error or have any questions, please drop us a line at [email protected]. Thanks!

ghost · 2016-08-31T05:11:08Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

gaearon · 2016-08-31T09:48:04Z

I think we should go with only docs folder as the simpler option.

gaearon · 2016-09-02T18:16:47Z

scripts/build.js

+      console.log('  ' + chalk.cyan('mv') + ' build/ docs/');
+      console.log('  ' + chalk.cyan('git') + ' add -f docs');
+      console.log('  ' + chalk.cyan('git') + ' commit -am ' + chalk.yellow('"Rebuild website"'));
+      console.log('  ' + chalk.cyan('git') + ' filter-branch -f --prune-empty --subdirectory-filter docs');


Do we need this command? I think it's only necessary for gh-pages because we needed to make a nested folder to be pushed as top-level.

gaearon · 2016-09-02T18:18:42Z

Left a few more comments, thanks again!

andyeskridge · 2016-09-04T02:28:41Z

Thanks for the input @gaearon! I'll see if I can carve out some time this weekend to clean it up!

andyeskridge · 2016-09-08T23:25:34Z

Sorry for the slow update. I've removed the old references and simplified the Github Pages documentation to focus only on deploying to a docs folder.

gaearon · 2016-09-09T10:28:13Z

scripts/build.js

      console.log('  ' + chalk.cyan('mv') + ' build/ docs/');
-      console.log('  ' + chalk.cyan('git') + ' add -f docs');
+      console.log('  ' + chalk.cyan('git') + ' add docs');


Would this need git add docs -A to remove old files from git? Could you please try to run these commands on a project and nail down the exact sequence before we recommend it?

andyeskridge · 2016-09-12T03:46:11Z

https://andyeskridge.github.io/docsTest/ is the result of running the commands through twice.

The test was running through the commands after creating a clean create-react-app and then making a small change to the source and running through the commands again.

The -A for the git commit correctly removes the old files from version control now.

fson · 2016-09-16T14:32:24Z

scripts/build.js

-      console.log('  ' + chalk.cyan('git') + ' add -f build');
+      console.log('  ' + chalk.cyan('rm') + ' -rf docs/');
+      console.log('  ' + chalk.cyan('mv') + ' build/ docs/');
+      console.log('  ' + chalk.cyan('git') + ' add docs -A');
      console.log('  ' + chalk.cyan('git') + ' commit -am ' + chalk.yellow('"Rebuild website"'));


The -a flag is probably not needed because we added the docs in the previous command?

Fine to keep for consistency so people don’t think it matters and stress over it.

fson · 2016-09-16T14:35:23Z

scripts/build.js

      console.log();
      console.log('  ' + chalk.cyan('git') + ' commit -am ' + chalk.yellow('"Save local changes"'));
-      console.log('  ' + chalk.cyan('git') + ' checkout -B gh-pages');
-      console.log('  ' + chalk.cyan('git') + ' add -f build');
+      console.log('  ' + chalk.cyan('rm') + ' -rf docs/');


If ./docs/CNAME file exists, we should preserve it. (Our current deployment code accidentally removes it, see #654.) When the custom domain is edited trough the GitHub Pages settings, GitHub saves it in this file.

fson · 2016-09-16T14:37:17Z

template/README.md

-git filter-branch -f --prune-empty --subdirectory-filter build
-git push -f origin gh-pages
-git checkout -
+git push  origin master


An extra space between push and origin.

gaearon · 2016-09-16T22:01:30Z

@fson
Thanks for reviewing!

@andyeskridge
Could you make these few changes? It’s good to go then. Cheers!

gaearon · 2016-09-17T22:09:20Z

I tried to use this instead:

git commit -am 'Save local changes'
rm -rf docs/static # need to do that to not delete CNAME
mv build/* docs # the command in this PR moved build *into* docs, this is the correct one
git add docs -A
git commit -am 'Rebuild website'
git push

However even that won’t work on Windows because it doesn’t have mv and rm.
And I couldn’t figure out how to make Windows analogs work when e.g. docs doesn’t exist yet.

At this point I think this is the wrong approach.
We should instead print something like:

npm install -g deploy-to-github # I made up that name
deploy-to-github

If a package like this already exists we should use it.
Otherwise we should just create this package.
It will do the steps above in a cross-platform way.

Thanks everybody for discussion and sorry about long back and forth.

Add new github docs folder hosting option

f8cc3b7

ghost added the CLA Signed label Aug 31, 2016

gaearon added the review-needs-changes label Sep 2, 2016

ghost added the CLA Signed label Sep 2, 2016

gaearon reviewed Sep 2, 2016
View reviewed changes

gaearon mentioned this pull request Sep 2, 2016

Change GitHub hosting instructions #501

Closed

ghost added the CLA Signed label Sep 4, 2016

remove old github pages documentation

50e8f77

Merge branch 'master' of github.com:facebookincubator/create-react-app

650bd43

gaearon reviewed Sep 9, 2016
View reviewed changes

update git add command to include -A

abebfca

fson mentioned this pull request Sep 16, 2016

Deploy script removes github pages custom domain #654

Closed

fson suggested changes Sep 16, 2016

View reviewed changes

gaearon added this to the 0.4.2 milestone Sep 16, 2016

facebook-github-bot added the CLA Signed label Sep 16, 2016

gaearon closed this Sep 17, 2016

gaearon removed this from the 0.4.2 milestone Sep 17, 2016

lock bot locked and limited conversation to collaborators Jan 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new github docs folder hosting option #520

Add new github docs folder hosting option #520

andyeskridge commented Aug 31, 2016

ghost commented Aug 31, 2016

ghost commented Aug 31, 2016

gaearon commented Aug 31, 2016

gaearon Sep 2, 2016

gaearon commented Sep 2, 2016

andyeskridge commented Sep 4, 2016

andyeskridge commented Sep 8, 2016

gaearon Sep 9, 2016

andyeskridge commented Sep 12, 2016

fson Sep 16, 2016

gaearon Sep 17, 2016

fson Sep 16, 2016 •

edited

Loading

fson Sep 16, 2016

gaearon commented Sep 16, 2016

gaearon commented Sep 17, 2016

Add new github docs folder hosting option #520

Add new github docs folder hosting option #520

Conversation

andyeskridge commented Aug 31, 2016

ghost commented Aug 31, 2016

ghost commented Aug 31, 2016

gaearon commented Aug 31, 2016

gaearon Sep 2, 2016

Choose a reason for hiding this comment

gaearon commented Sep 2, 2016

andyeskridge commented Sep 4, 2016

andyeskridge commented Sep 8, 2016

gaearon Sep 9, 2016

Choose a reason for hiding this comment

andyeskridge commented Sep 12, 2016

fson Sep 16, 2016

Choose a reason for hiding this comment

gaearon Sep 17, 2016

Choose a reason for hiding this comment

fson Sep 16, 2016 • edited Loading

Choose a reason for hiding this comment

fson Sep 16, 2016

Choose a reason for hiding this comment

gaearon commented Sep 16, 2016

gaearon commented Sep 17, 2016

fson Sep 16, 2016 •

edited

Loading