-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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
refactor: rename Git master branch to main #5345
Conversation
✔️ [V2] 🔨 Explore the source changes: f857362 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61167f7039c88c0007183d65 😎 Browse the preview: https://deploy-preview-5345--docusaurus-2.netlify.app |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5345--docusaurus-2.netlify.app/ |
I have helped migrate a few big repositories to the I recommend you read the docs on renaming branches to learn what GitHub will do for you, and what you need to do yourself. GitHub will do a lot of heavy lifting:
The things you'll need to change/check yourself include:
To benefit from GitHub doing the heavy lifting, you need to do the branchname changeover from within the GitHub Interface! |
Thanks I'll sync with Joel to see how to make this happen, as I'm not a repo admin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @zpao
I think we'll do the switch today so I'm going to follow up and complete this PR right now
packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json
Outdated
Show resolved
Hide resolved
...s/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json
Outdated
Show resolved
Hide resolved
packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json
Outdated
Show resolved
Hide resolved
packages/docusaurus/src/webpack/react-dev-utils-webpack5/formatWebpackMessages.js
Show resolved
Hide resolved
website/versioned_docs/version-2.0.0-beta.4/migration/migration-manual.md
Outdated
Show resolved
Hide resolved
…_version_website/website/package.json
…_website/website/package.json
…website/website/package.json
# Conflicts: # .github/workflows/v2-tests-e2e.yml
* Prepare to renaming master branch to main * Update CONTRIBUTING.md * Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json * Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json * Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json * missing master -> main replaces * useless char * For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required * fix versioning page * fix vercel links * update deployment.mdx Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com> Co-authored-by: slorber <lorber.sebastien@gmail.com>
Breaking changes:
docusaurus deploy
does not assume anymore which Git branch is your default one, and it must be provided explicitly with theDEPLOYMENT_BRANCH
env variableWe should transition over to the use of
main
as opposed tomaster
, following a wider effort as we've seen by a number of projects in the React family.This isn't a pure find+replace - I did my best to be precise here but I don't know project that well so it's possible there are mistakes.