-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ada66d3
Showing
38 changed files
with
2,489 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*.config linguist-language=nextflow |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Dockstore config version, not pipeline version | ||
version: 1.2 | ||
workflows: | ||
- subclass: nfl | ||
primaryDescriptorPath: /nextflow.config |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# nf-core/eager: Contributing Guidelines | ||
|
||
Hi there! | ||
Many thanks for taking an interest in improving nf-core/eager. | ||
|
||
We try to manage the required tasks for nf-core/eager using GitHub issues, you probably came to this page when creating one. | ||
Please use the pre-filled template to save time. | ||
|
||
However, don't be put off by this template - other more general issues and suggestions are welcome! | ||
Contributions to the code are even more welcome ;) | ||
|
||
> If you need help using or modifying nf-core/eager then the best place to ask is on the nf-core Slack [#eager](https://nfcore.slack.com/channels/eager) channel ([join our Slack here](https://nf-co.re/join/slack)). | ||
## Contribution workflow | ||
|
||
If you'd like to write some code for nf-core/eager, the standard workflow is as follows: | ||
|
||
1. Check that there isn't already an issue about your idea in the [nf-core/eager issues](https://github.com/nf-core/eager/issues) to avoid duplicating work | ||
* If there isn't one already, please create one so that others know you're working on this | ||
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/eager repository](https://github.com/nf-core/eager) to your GitHub account | ||
3. Make the necessary changes / additions within your forked repository | ||
4. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged | ||
|
||
If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/). | ||
|
||
## Tests | ||
|
||
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests. | ||
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then. | ||
|
||
There are typically two types of tests that run: | ||
|
||
### Lint Tests | ||
|
||
`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to. | ||
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core lint <pipeline-directory>` command. | ||
|
||
If any failures or warnings are encountered, please follow the listed URL for more documentation. | ||
|
||
### Pipeline Tests | ||
|
||
Each `nf-core` pipeline should be set up with a minimal set of test-data. | ||
`GitHub Actions` then runs the pipeline on this data to ensure that it exits successfully. | ||
If there are any failures then the automated tests fail. | ||
These tests are run both with the latest available version of `Nextflow` and also the minimum required version that is stated in the pipeline code. | ||
|
||
## Patch | ||
|
||
:warning: Only in the unlikely and regretful event of a release happening with a bug. | ||
|
||
* On your own fork, make a new branch `patch` based on `upstream/master`. | ||
* Fix the bug, and bump version (X.Y.Z+1). | ||
* A PR should be made on `master` from patch to directly this particular bug. | ||
|
||
## Getting help | ||
|
||
For further information/help, please consult the [nf-core/eager documentation](https://nf-co.re/eager/docs) and don't hesitate to get in touch on the nf-core Slack [#eager](https://nfcore.slack.com/channels/eager) channel ([join our Slack here](https://nf-co.re/join/slack)). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<!-- | ||
# nf-core/eager bug report | ||
Hi there! | ||
Thanks for telling us about a problem with the pipeline. | ||
Please delete this text and anything that's not relevant from the template below: | ||
--> | ||
|
||
## Description of the bug | ||
|
||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
## Steps to reproduce | ||
|
||
Steps to reproduce the behaviour: | ||
|
||
1. Command line: <!-- [e.g. `nextflow run ...`] --> | ||
2. See error: <!-- [Please provide your error message] --> | ||
|
||
## Expected behaviour | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## System | ||
|
||
- Hardware: <!-- [e.g. HPC, Desktop, Cloud...] --> | ||
- Executor: <!-- [e.g. slurm, local, awsbatch...] --> | ||
- OS: <!-- [e.g. CentOS Linux, macOS, Linux Mint...] --> | ||
- Version <!-- [e.g. 7, 10.13.6, 18.3...] --> | ||
|
||
## Nextflow Installation | ||
|
||
- Version: <!-- [e.g. 19.10.0] --> | ||
|
||
## Container engine | ||
|
||
- Engine: <!-- [e.g. Conda, Docker or Singularity] --> | ||
- version: <!-- [e.g. 1.0.0] --> | ||
- Image tag: <!-- [e.g. nfcore/eager:1.0.0] --> | ||
|
||
## Additional context | ||
|
||
<!-- Add any other context about the problem here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- | ||
# nf-core/eager feature request | ||
Hi there! | ||
Thanks for suggesting a new feature for the pipeline! | ||
Please delete this text and anything that's not relevant from the template below: | ||
--> | ||
|
||
## Is your feature request related to a problem? Please describe | ||
|
||
<!-- A clear and concise description of what the problem is. --> | ||
|
||
<!-- e.g. [I'm always frustrated when ...] --> | ||
|
||
## Describe the solution you'd like | ||
|
||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
## Describe alternatives you've considered | ||
|
||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
## Additional context | ||
|
||
<!-- Add any other context about the feature request here. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- | ||
# nf-core/eager pull request | ||
Many thanks for contributing to nf-core/eager! | ||
Please fill in the appropriate checklist below (delete whatever is not relevant). | ||
These are the most common things requested on pull requests (PRs). | ||
Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release. | ||
Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md) | ||
--> | ||
|
||
## PR checklist | ||
|
||
- [ ] This comment contains a description of changes (with reason) | ||
- [ ] `CHANGELOG.md` is updated | ||
- [ ] If you've fixed a bug or added code that should be tested, add tests! | ||
- [ ] Documentation in `docs` is updated | ||
- [ ] If necessary, also make a PR on the [nf-core/eager branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/eager) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Markdownlint configuration file | ||
default: true, | ||
line-length: false | ||
no-duplicate-header: | ||
siblings_only: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: nf-core AWS full size tests | ||
# This workflow is triggered on push to the master branch. | ||
# It runs the -profile 'test_full' on AWS batch | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
run-awstest: | ||
name: Run AWS full tests | ||
if: github.repository == 'nf-core/eager' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Setup Miniconda | ||
uses: goanpeca/[email protected] | ||
with: | ||
auto-update-conda: true | ||
python-version: 3.7 | ||
- name: Install awscli | ||
run: conda install -c conda-forge awscli | ||
- name: Start AWS batch job | ||
# TODO nf-core: You can customise AWS full pipeline tests as required | ||
# Add full size test data (but still relatively small datasets for few samples) | ||
# on the `test_full.config` test runs with only one set of parameters | ||
# Then specify `-profile test_full` instead of `-profile test` on the AWS batch command | ||
env: | ||
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }} | ||
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }} | ||
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }} | ||
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }} | ||
run: | | ||
aws batch submit-job \ | ||
--region eu-west-1 \ | ||
--job-name nf-core-eager \ | ||
--job-queue $AWS_JOB_QUEUE \ | ||
--job-definition $AWS_JOB_DEFINITION \ | ||
--container-overrides '{"command": ["nf-core/eager", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/eager/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/eager/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: nf-core AWS test | ||
# This workflow is triggered on push to the master branch. | ||
# It runs the -profile 'test' on AWS batch | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
run-awstest: | ||
name: Run AWS tests | ||
if: github.repository == 'nf-core/eager' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Setup Miniconda | ||
uses: goanpeca/[email protected] | ||
with: | ||
auto-update-conda: true | ||
python-version: 3.7 | ||
- name: Install awscli | ||
run: conda install -c conda-forge awscli | ||
- name: Start AWS batch job | ||
# TODO nf-core: You can customise CI pipeline run tests as required | ||
# For example: adding multiple test runs with different parameters | ||
# Remember that you can parallelise this by using strategy.matrix | ||
env: | ||
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }} | ||
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }} | ||
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }} | ||
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }} | ||
run: | | ||
aws batch submit-job \ | ||
--region eu-west-1 \ | ||
--job-name nf-core-eager \ | ||
--job-queue $AWS_JOB_QUEUE \ | ||
--job-definition $AWS_JOB_DEFINITION \ | ||
--container-overrides '{"command": ["nf-core/eager", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/eager/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/eager/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}'eager/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: nf-core branch protection | ||
# This workflow is triggered on PRs to master branch on the repository | ||
# It fails when someone tries to make a PR against the nf-core `master` branch instead of `dev` | ||
on: | ||
pull_request: | ||
branches: [master] | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# PRs to the nf-core repo master branch are only ok if coming from the nf-core repo `dev` or any `patch` branches | ||
- name: Check PRs | ||
if: github.repository == 'nf-core/eager' | ||
run: | | ||
{ [[ ${{github.event.pull_request.head.repo.full_name}} == nf-core/eager ]] && [[ $GITHUB_HEAD_REF = "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]] | ||
# If the above check failed, post a comment on the PR explaining the failure | ||
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets | ||
- name: Post PR comment | ||
if: failure() | ||
uses: mshick/add-pr-comment@v1 | ||
with: | ||
message: | | ||
Hi @${{ github.event.pull_request.user.login }}, | ||
It looks like this pull-request is has been made against the ${{github.event.pull_request.head.repo.full_name}} `master` branch. | ||
The `master` branch on nf-core repositories should always contain code from the latest release. | ||
Because of this, PRs to `master` are only allowed if they come from the ${{github.event.pull_request.head.repo.full_name}} `dev` branch. | ||
You do not need to close this PR, you can change the target branch to `dev` by clicking the _"Edit"_ button at the top of this page. | ||
Thanks again for your contribution! | ||
repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
allow-repeats: false | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
name: nf-core CI | ||
# This workflow runs the pipeline with the minimal test dataset to check that it completes without any syntax errors | ||
on: | ||
push: | ||
branches: | ||
- dev | ||
pull_request: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
test: | ||
name: Run workflow tests | ||
# Only run on push if this is the nf-core dev branch (merged PRs) | ||
if: ${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/eager') }} | ||
runs-on: ubuntu-latest | ||
env: | ||
NXF_VER: ${{ matrix.nxf_ver }} | ||
NXF_ANSI_LOG: false | ||
strategy: | ||
matrix: | ||
# Nextflow versions: check pipeline minimum and current latest | ||
nxf_ver: ['19.10.0', ''] | ||
steps: | ||
- name: Check out pipeline code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Check if Dockerfile or Conda environment changed | ||
uses: technote-space/get-diff-action@v1 | ||
with: | ||
PREFIX_FILTER: | | ||
Dockerfile | ||
environment.yml | ||
- name: Build new docker image | ||
if: env.GIT_DIFF | ||
run: docker build --no-cache . -t nfcore/eager:dev | ||
|
||
- name: Pull docker image | ||
if: ${{ !env.GIT_DIFF }} | ||
run: | | ||
docker pull nfcore/eager:dev | ||
docker tag nfcore/eager:dev nfcore/eager:dev | ||
- name: Install Nextflow | ||
run: | | ||
wget -qO- get.nextflow.io | bash | ||
sudo mv nextflow /usr/local/bin/ | ||
- name: Run pipeline with test data | ||
# TODO nf-core: You can customise CI pipeline run tests as required | ||
# For example: adding multiple test runs with different parameters | ||
# Remember that you can parallelise this by using strategy.matrix | ||
run: | | ||
nextflow run ${GITHUB_WORKSPACE} -profile test,docker |
Oops, something went wrong.