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.

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

Need warning in docs about bumping master branch during deployment to gh pages #24479

Closed
Ildarik opened this issue May 26, 2020 · 6 comments · Fixed by #24538
Closed

Need warning in docs about bumping master branch during deployment to gh pages #24479

Ildarik opened this issue May 26, 2020 · 6 comments · Fixed by #24538
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@Ildarik
Copy link
Contributor

Ildarik commented May 26, 2020

Recently I faced same issue as described here
Maybe we need some sort of warning or tip in docs about that issue?

Short description of the problem:
We are developing something on the master btanch as usual. And want to deploy it on Github Pages. We see in the documentation how to do that in Gatsby world but don't pay attention to that we are bumping our master branch. So I would suggest adding a tip to checkout master branch to source branch before running npm run deploy.

@Ildarik Ildarik added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label May 26, 2020
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label May 26, 2020
@LekoArts LekoArts removed the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label May 26, 2020
@LekoArts
Copy link
Contributor

Hi, thanks for the issue!

What issue did you face? The issue you linked is working as intended and the docs explain this usecase.

@Ildarik
Copy link
Contributor Author

Ildarik commented May 26, 2020

@LekoArts added description of the problem

@LekoArts
Copy link
Contributor

Reading your updated comment I feel like you should follow these instructions, right?
https://www.gatsbyjs.org/docs/how-gatsby-works-with-github-pages/#deploying-to-a-path-on-github-pages

Because with this script you'll always deploy to another branch than master

@Ildarik
Copy link
Contributor Author

Ildarik commented May 26, 2020

No, correct link is https://www.gatsbyjs.org/docs/how-gatsby-works-with-github-pages/#deploying-to-a-github-pages-subdomain-at-githubio

GH pages forces to deploy to master branch for user\organization pages.

@LekoArts
Copy link
Contributor

Ah, I see!

Documenting those two options (#13120 (comment)) sounds reasonable. Would you be up for opening a PR adding this? :)

@Ildarik
Copy link
Contributor Author

Ildarik commented May 26, 2020

Sure!
I'll do it today a little bit later! Thanks!)

Ildarik added a commit to Ildarik/gatsby that referenced this issue May 26, 2020
marcysutton pushed a commit that referenced this issue Jun 10, 2020
* Close #24479

* chore: format

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
axe312ger pushed a commit that referenced this issue Jun 23, 2020
* Close #24479

* chore: format

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
pragmaticpat pushed a commit to pragmaticpat/gatsby that referenced this issue Apr 28, 2022
* Close gatsbyjs#24479

* chore: format

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/how-gatsby-works-with-github-pages.md

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>

Co-authored-by: Marcy Sutton <marcy@gatsbyjs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
2 participants