-
Notifications
You must be signed in to change notification settings - Fork 188
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
[create] Option to set branch names #1961
base: dev
Are you sure you want to change the base?
Conversation
4c0c5a5
to
d6cd410
Compare
Docs are missing. I would welcome contributions. |
Codecov Report
@@ Coverage Diff @@
## dev #1961 +/- ##
===========================================
- Coverage 71.95% 61.11% -10.85%
===========================================
Files 77 37 -40
Lines 8363 4678 -3685
===========================================
- Hits 6018 2859 -3159
+ Misses 2345 1819 -526
... and 75 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
My main question with this (and also #1959) is why do we want the default branch name to be variable? Surely we want it to always be Is it not better to just manually set the branch name after init with hardcoded values instead of passing variables around and letting defaults / CLI options set this, if having anything other than master will break everything else downstream? |
I agree that hardcoding master would work for the functionality of the status quo and it is simpler - so more desirable. My thinking behind the parametrization was that it will make it easier to try and test things during the migration from master to main. Once the migration is done, the branch customization can/should be stripped out of the code base again. Logging a warning when branch customization is used might be indeed a good idea if it is decided to keep it for the specific task of migrating to main. |
A reason to make the default branch name accessible now is that it would allow for people who use nf-core tools to create non-nfcore pipelines to begin using main as the default branch now. I would love to see this change merged now and would be happy to contribute some docs writing if that's holding things up. |
Follow up PR to #1959
Closes #1960
PR checklist
CHANGELOG.md
is updateddocs
is updated