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

docs: master branch -> main branch, default branch -> base branch #9808

Merged

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented May 1, 2021

Changes:

  • Replace the term master with main where possible and supported
  • Make a section explaining the master vs main branch thing in the FAQ
  • Use the term "base branch" instead of "default branch"
  • Fix-up some other small stuff I found while doing this PR

Context:

Closes #9693.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • No new tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Copy link
Collaborator Author

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some questions from my end. 😉

docs/usage/config-presets.md Outdated Show resolved Hide resolved
docs/usage/config-presets.md Outdated Show resolved Hide resolved
docs/usage/self-hosting.md Outdated Show resolved Hide resolved
docs/usage/setup-azure-devops.md Show resolved Hide resolved
lib/manager/azure-pipelines/readme.md Show resolved Hide resolved
@rarkins
Copy link
Collaborator

rarkins commented May 1, 2021

I think all platforms support arbitrary domain names. It was always possible to change the default branch of a repo. Let's assume as much.

@viceice
Copy link
Member

viceice commented May 1, 2021

Yeah, let's speak about default branch where possible and use main and / or master as some examples

@HonkingGoose
Copy link
Collaborator Author

I think all platforms support arbitrary domain names. It was always possible to change the default branch of a repo. Let's assume as much.

Okay!

Yeah, let's speak about default branch where possible and use main and / or master as some examples

All of our code examples now use main instead of master. Or do you want me to use default-branch as the branchname in our config examples?

@viceice
Copy link
Member

viceice commented May 1, 2021

🤔 i think using default branch is more future prove.

@rarkins what do you think?

@rarkins
Copy link
Collaborator

rarkins commented May 1, 2021

🤔 i think using default branch is more future prove.

@rarkins what do you think?

You're probably right. Although now I look, I think many of these should be "the base branch" instead.

@viceice
Copy link
Member

viceice commented May 1, 2021

Yeah, base branch is probably a better terminology for renovate

@HonkingGoose
Copy link
Collaborator Author

If we want to be consistent throughout, I would need to find/replace default branch -> base branch throughout the docs in most places. I left those changes out for now, until I know if you like this direction or not. 😄

@viceice
Copy link
Member

viceice commented May 1, 2021

Sounds good

@HonkingGoose HonkingGoose changed the title docs: migrate from master to main docs: master branch -> main branch, default branch -> base branch May 2, 2021
@HonkingGoose HonkingGoose marked this pull request as ready for review May 2, 2021 07:22
@HonkingGoose
Copy link
Collaborator Author

I think this is ready for another round of review. 😄

I've changed the pull request title as the scope of the PR has changed between opening and now, please check if that's good. Feel free to change it into something else if needed. 😉

.github/contributing.md Outdated Show resolved Hide resolved
docs/development/design-decisions.md Outdated Show resolved Hide resolved
docs/development/shareable-configs.md Outdated Show resolved Hide resolved
docs/usage/config-presets.md Outdated Show resolved Hide resolved
docs/usage/config-presets.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
docs/usage/faq.md Outdated Show resolved Hide resolved
docs/usage/faq.md Outdated Show resolved Hide resolved
docs/usage/faq.md Outdated Show resolved Hide resolved
Co-authored-by: Rhys Arkins <rhys@arkins.net>
@HonkingGoose
Copy link
Collaborator Author

@rarkins said earlier:

You're probably right. Although now I look, I think many of these should be "the base branch" instead.

I made the change to base branch but I think you're not really happy with that, as most of your suggestions reverted that change. 😄

Can you explain why you didn't like base branch after all? Is it maybe because we also have a baseBranches property that people could get confused with?

@rarkins
Copy link
Collaborator

rarkins commented May 2, 2021

Base branch is a relative term, different to default branch.

A repo has only one default branch (eg main/master) but base branch is relative to PRs and there can be multiple.

To a PR, it's the base branch that matters. To a repo, it's default branch.

@HonkingGoose
Copy link
Collaborator Author

To a PR, it's the base branch that matters. To a repo, it's default branch.

Ah okay! 😄

@HonkingGoose HonkingGoose marked this pull request as draft May 2, 2021 09:35
@HonkingGoose

This comment has been minimized.

@HonkingGoose HonkingGoose marked this pull request as ready for review May 3, 2021 07:20
@rarkins rarkins enabled auto-merge (squash) May 3, 2021 07:25
@rarkins rarkins merged commit 75b5e9d into renovatebot:main May 3, 2021
@HonkingGoose HonkingGoose deleted the docs/use-main-instead-of-master branch May 3, 2021 07:35
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 25.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: use main instead of master
5 participants