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: use main instead of master when referring to Git branch #2214

Open
HonkingGoose opened this issue Oct 29, 2021 · 6 comments
Open

docs: use main instead of master when referring to Git branch #2214

HonkingGoose opened this issue Oct 29, 2021 · 6 comments

Comments

@HonkingGoose
Copy link
Contributor

HonkingGoose commented Oct 29, 2021

New feature motivation

The semantic-release docs use master when referring to a Git branch. I think this should be changed (eventually) to main seeing as GitHub and GitLab now default to main for new repositories.

I think this issue must be resolved first, before somebody can change the references in the docs?

New feature description

Replace master with main when referring to a Git branch in the semantic-release documentation.

If needed you can add a short explanation stating that master is the old term and the many Git hosting providers settled on using main instead.

New feature implementation

@nealeu
Copy link

nealeu commented Nov 11, 2021

From what I understand, there's more to it than this because if you don't set up any branches, semantic-release assumes master.
I think it's time main were assumed in preference to master and if both exist, then semantic release would require branches config.

@gr2m
Copy link
Member

gr2m commented Nov 11, 2021

Once we finish the ESM transition, working on supporting main out-of-the-box will be a high priority for me. I'd wait until then before adjusting the docs

@NeilJ247
Copy link

NeilJ247 commented Feb 2, 2022

Is there anyway to configure semantic-release to work with main at the moment? I've added main to release -> branches config but it errors with ERELEASEBRANCHES

@bimawa
Copy link

bimawa commented Aug 15, 2022

Hey @gr2m Any news about this feature? ^_^ ty <3
or better migrate from main to master back?

@jawys
Copy link

jawys commented Nov 30, 2022

Hey @gr2m Any news about this feature? ^_^ ty <3 or better migrate from main to master back?

Hey @gr2m same question here: must I migrate all my companys default branches back to master ? 😄

Or could you need some help? and where?

@nealeu
Copy link

nealeu commented Nov 30, 2022

Ditto. Come on folks. I'm starting to think peeps are that little bit... you know... anti-woke... aka ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants