semantic-release icon indicating copy to clipboard operation
semantic-release copied to clipboard

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

Open HonkingGoose opened this issue 3 years ago • 4 comments

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 issue #1581 needs to 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

HonkingGoose avatar Oct 29 '21 09:10 HonkingGoose

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.

nealeu avatar Nov 11 '21 14:11 nealeu

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

gr2m avatar Nov 11 '21 16:11 gr2m

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

NeilJ247 avatar Feb 02 '22 15:02 NeilJ247

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

bimawa avatar Aug 15 '22 18:08 bimawa

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?

jawys avatar Nov 30 '22 12:11 jawys

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

nealeu avatar Nov 30 '22 14:11 nealeu