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
Add GitHub Actions to Template #369
Conversation
This PR is based on nf-core/sarek#27 |
SVG images are missing... But could probably just use shields.io anyway? Travis stuff that I think we're still missing:
Would be good to have the branch stuff in it's own file / test I think? Would be super quick then and I like having the tests split up like that to make it super clear.. Great work! |
From here:
|
Good point, I totally forgot about that one, I'll add that to the test on my sarek PR
That's exactly the link I used, I just figured one need to replace {owner}, {repo} and {workflow_name}, but I'm guessing it might have been working with the old Actions, and not this one, I'll keep looking EDIT: Never mind, I found out how it works... It's pretty tricky in fact, for workflow_name you have to put indeed the workflow_name, wich is the name that you give the workflow in the yml file, and not the name of the yml file itself... Here is how it works for Nextflow (the yml file being |
Nothing on shields.io yet, if I understood this issue: badges/shields#2574 |
I fixed the badges, and added a test to protect master: https://github.com/nf-core/tools/blob/2a959e24b530c551d52ce42c4c2b22a73e65a55e/nf_core/pipeline-template/%7B%7Bcookiecutter.name_noslash%7D%7D/.github/workflows/branch.yml It's only triggered for master branch, and check that the GITHUB_AUTHOR is nf-core and that the head branch is dev, which should ensure the same test we were doing. It should need further testing to verify that, so do not merge until we're sure with the Sarek PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only question remaining for me: Are we dropping TravisCI in favor for this? Looks faster, more streamlined, better implemented and once you grasp the concept I don't see a reason to keep TravisCI tests in :D
I would say yes in the long term, but not now, it's still in beta :-D |
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/ci.yml
Outdated
Show resolved
Hide resolved
…b/workflows/ci.yml Co-Authored-By: Phil Ewels <phil.ewels@scilifelab.se>
Quick question about the branch protection. |
We do, it's
|
I know, the important part of the question was:
|
Yeah, having some docs on what / how we It shouldn't be used too often, though I hope 😆 |
I updated the |
Anyone has any idea why tests are failing on that one? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of double cookiecutter
s are breaking the templating..
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/CONTRIBUTING.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/CONTRIBUTING.md
Outdated
Show resolved
Hide resolved
🤦♂️ |
Co-Authored-By: Phil Ewels <phil.ewels@scilifelab.se>
@ewels what do you think about the mergability of this one? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! I added a few minor suggested changes for docs and comment tweaks, but that's all.
Note that we'll need to update nf-core bump-version
and nf-core lint
, and also remove .travis.yml
as part of that, but we can do that in a separate PR I guess.
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/CONTRIBUTING.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/CONTRIBUTING.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/ISSUE_TEMPLATE/bug_report.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/ISSUE_TEMPLATE/bug_report.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/ISSUE_TEMPLATE/bug_report.md
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/branch.yml
Outdated
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/branch.yml
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/ci.yml
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/ci.yml
Show resolved
Hide resolved
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/workflows/linting.yml
Show resolved
Hide resolved
Thanks to @ewels for useful suggestions Co-Authored-By: Phil Ewels <phil.ewels@scilifelab.se>
nf_core/pipeline-template/{{cookiecutter.name_noslash}}/.github/CONTRIBUTING.md
Outdated
Show resolved
Hide resolved
…b/CONTRIBUTING.md
Many thanks to contributing to nf-core/tools!
Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested on pull requests (PRs).
PR checklist
docs
is updatedCHANGELOG.md
is updatedREADME.md
is updatedLearn more about contributing: https://github.com/nf-core/tools/tree/master/.github/CONTRIBUTING.md