Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Auto deploy docs preview for every PR #5807

Closed
iansu opened this issue Nov 14, 2018 · 17 comments
Closed

Auto deploy docs preview for every PR #5807

iansu opened this issue Nov 14, 2018 · 17 comments
Labels
stale tag: internal

Comments

@iansu
Copy link
Contributor

iansu commented Nov 14, 2018

It would be nice to be able to see a preview of the docs when someone submits a change. We should be able to set that up using something like Netlify.
@iansu
Copy link
Contributor Author

iansu commented Nov 14, 2018

Maybe @sw-yx can help us out with this?

@swyxio
Copy link
Contributor

swyxio commented Nov 14, 2018

hey! yea sure. really you just have to push this up on Netlify and its a button click away. do you want to do it on your own account? if i do it on mine i don't think i can transfer it over to you.

just let me know when youve done it and i'll put you on the free OSS plan.

@iansu
Copy link
Contributor Author

iansu commented Nov 14, 2018

That's something we need to figure out. Do we also need to install something in the GitHub repo so the link to the deploy appears on each PR? If so we'll need to ask @gaearon to do that.

@swyxio
Copy link
Contributor

swyxio commented Nov 14, 2018 •
edited
Loading

hmm. might need to install the Netlify Github app, yes. but it might already be installed since reactjs.org is on netlify.

@iansu
Copy link
Contributor Author

iansu commented Nov 14, 2018

At the very least it will be easier to convince someone to install it if React is already using it.

@swyxio
Copy link
Contributor

swyxio commented Nov 14, 2018

alright lets wait for Dan to see this. sounds like you do need an install

@gaearon
Copy link
Contributor

gaearon commented Nov 28, 2018

I don't know what to do with this. If someone gives me exact instructions I can set it up. :-)

screen shot 2018-11-28 at 5 31 34 pm

@iansu
Copy link
Contributor Author

iansu commented Nov 28, 2018

I'll see if I can get this working with my fork of CRA and post some more specific instructions.

@swyxio swyxio mentioned this issue Nov 30, 2018
Merged
@swyxio
Copy link
Contributor

swyxio commented Nov 30, 2018 •
edited
Loading

@gaearon and @iansu apologies for the confusion. some setup was needed to deploy this monorepo/docusaurus setup. the best way to do this is with a netlify.toml configuration - in #5930 i have created a PR to set that up in CRA.

You can see the result of this deploy here: https://trusting-lichterman-ee04c1.netlify.com

gaearon pushed a commit that referenced this issue Nov 30, 2018
@swyxio @gaearon
Add netlify.toml to prepare for deploy to netlify #5807 (#5930)
ffb219d 
* commit toml

* full build path

* wow the path is long

* redirect
@iansu
Copy link
Contributor Author

iansu commented Nov 30, 2018

This is awesome. Thanks! 🎉

I think the baseUrl is set to /create-react-app because we're deploying to GitHub pages.

What do we need to do to get this finished? I see that Dan has already merged your config PR. What else do you need from us?

@swyxio
Copy link
Contributor

swyxio commented Nov 30, 2018 •
edited
Loading

just need to proceed with the deploy :) You or Dan can do it since you should be on the "react team" within Netlify.

  • https://app.netlify.com/start
  • hit Github
  • choose the facebook org and search for the c-r-a repo
  • that will get you to where dan was above but this time you dont need to write any build settings, its done for you by the config. leave the settings blank and just hit "Deploy site".

Once its deployed we can worry about naming. Do you want create-react-app.netlify.com? or do you want some more custom domain? (cra.io?) could even consider facebook.netlify.com/create-react-app. we have someone squatting on https://cra.netlify.com/ but we could boot them if you want.

@iansu
Copy link
Contributor Author

iansu commented Dec 1, 2018

Deployed! I'm not sure about the domain name right now. I think we will continue using the GitHub pages URL until we come up with something better. This is a great start though. Now we can preview the docs when someone submits a PR. 🎉

@iansu
Copy link
Contributor Author

iansu commented Dec 1, 2018

Thanks for all your help @sw-yx! 😀

@iansu
Copy link
Contributor Author

iansu commented Dec 3, 2018

@sw-yx I'd like to change the name of our app to just create-react-app but it seems like it's not available. It doesn't really seem to be in use though. Can you help with that?

@swyxio
Copy link
Contributor

swyxio commented Dec 3, 2018 •
edited
Loading

yup on it. will take a while, i have to follow procedure with the squatter

Update: squatter gave the ok. Should be released for you to claim by tomorrow

timsnadden added a commit to timsnadden/create-react-app that referenced this issue Dec 7, 2018
@timsnadden
Merge branch 'master' into checkYarnRegistry
fb0b775 
* master: (39 commits)
  Added extension to .eslintrc (facebook#5988)
  Update links to docs in all package README files (facebook#5912)
  Use https for linked images in docs to fix mixed content warnings (facebook#5985)
  Improve error messaging in verifyPackageTree.js (facebook#5974)
  Add removeItem to localStorage mock in docs (facebook#5919)
  Add SASS_PATH instructions to Sass docs (facebook#5917)
  Suggest a different default for speed reasons (facebook#5959)
  Add pre-eject message about new features in v2 (facebook#5954)
  Add netlify.toml to prepare for deploy to netlify facebook#5807 (facebook#5930)
  Correct some comments (facebook#5927)
  Add note to docs about using Sass and Flow together (facebook#5823)
  Update PWA link in README (facebook#5907)
  Add placeholders to template README for bit.ly links. (facebook#5808)
  Disable copy to clipboard in cra --info (facebook#5905)
  Support setupTests.ts (facebook#5698)
  Remove unnecessary whitespace in template HTML
  Run prettier on HTML files (facebook#5839)
  Some Grammar fixes (facebook#5858)
  Fix link to page about running tests (facebook#5883)
  fix: make typescriptformatter support 0.5 of fork checker (facebook#5879)
  ...
@stale
Copy link

stale bot commented Jan 3, 2019

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs.

@stale stale bot added the stale label Jan 3, 2019
@iansu
Copy link
Contributor Author

iansu commented Jan 3, 2019

This is done!

@iansu iansu closed this as completed Jan 3, 2019
@lock lock bot locked and limited conversation to collaborators Jan 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
stale tag: internal
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@iansu @gaearon @swyxio