GitHub default repository name change from master to main #360
Conversation
As Github changed the default branch name from master, to main for new repositories, we should update in ADF as well, so customers will not require to modify the main branch in Github or provider custom parameter for branch.
Github changed default branch name from master to main. Updating this in documentation to affect together with GIthub CDK helper code, which was updated in this proposed change.
sbkok
left a comment
sbkok
left a comment
There was a problem hiding this comment.
Thanks for proposing this change @ippetrus!
Would be great to have support for this and rely on main as the default branch.
The current change you proposed would imply breaking change to every user that has GitHub setup but still relies on the master branch. Could you make it a configuration property as part of the adfconfig.yml, which would:
- When installed as new, use
mainin the adfconfig as the default. - When upgrading and no config is present, would use
masterin the adfconfig as the default.
Plus it would be great to show a deprecation warning for customers that are upgrading and relying on the master branch as being the default. In the future, as part of a v4.0 release, I would like to phase out the term master all together and rely on main as the default branch for all installs/upgrades.
If you don't know how to start on this, please reach out, I'm happy to help out getting this sorted. This would be a great improvement to ADF I think.
|
I'm closing this PR, as it is superseded by #370. |
2 participants
Issue #, if available: None
Description of changes:
Github changed the name of the default branch name which is created when you create a new repository from master to main. There are two minor changes with this pull request. Only the default github branch is changed from master to main.
Also this name change is updated in the doc file too.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.