Skip to content

Commit 0677fee

Browse files
committed
Template update for nf-core/tools version 2.0
1 parent f134d13 commit 0677fee

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+2812
-1885
lines changed

.editorconfig

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_size = 4
9+
indent_style = space
10+
11+
[*.{yml,yaml}]
12+
indent_size = 2
13+
14+
# These files are edited and tested upstream in nf-core/modules
15+
[/modules/nf-core/**]
16+
charset = unset
17+
end_of_line = unset
18+
insert_final_newline = unset
19+
trim_trailing_whitespace = unset
20+
indent_style = unset
21+
indent_size = unset
22+
23+
[/assets/email*]
24+
indent_size = unset

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ If you wish to contribute a new step, please use the following coding standards:
7474
7. Add sanity checks for all relevant parameters.
7575
8. Add any new software to the `scrape_software_versions.py` script in `bin/` and the version command to the `scrape_software_versions` process in `main.nf`.
7676
9. Do local tests that the new code works properly and as expected.
77-
10. Add a new test command in `.github/workflow/ci.yaml`.
77+
10. Add a new test command in `.github/workflow/ci.yml`.
7878
11. If applicable add a [MultiQC](https://https://multiqc.info/) module.
7979
12. Update MultiQC config `assets/multiqc_config.yaml` so relevant suffixes, name clean up, General Statistics Table column order, and module figures are in the right order.
8080
13. Optional: Add any descriptions of MultiQC report sections and output files to `docs/output.md`.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Please delete this text and anything that's not relevant from the template below
1818
I have checked the following places for your error:
1919

2020
- [ ] [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
21-
- [ ] [nf-core/rnaseq pipeline documentation](https://nf-co.re/nf-core/rnaseq/usage)
21+
- [ ] [nf-core/rnaseq pipeline documentation](https://nf-co.re/rnaseq/usage)
2222

2323
## Description of the bug
2424

@@ -51,13 +51,12 @@ Have you provided the following extra information/files:
5151

5252
## Nextflow Installation
5353

54-
- Version: <!-- [e.g. 19.10.0] -->
54+
- Version: <!-- [e.g. 21.04.0] -->
5555

5656
## Container engine
5757

5858
- Engine: <!-- [e.g. Conda, Docker, Singularity, Podman, Shifter or Charliecloud] -->
5959
- version: <!-- [e.g. 1.0.0] -->
60-
- Image tag: <!-- [e.g. nfcore/rnaseq:1.0.0] -->
6160

6261
## Additional context
6362

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnas
1616

1717
- [ ] This comment contains a description of changes (with reason).
1818
- [ ] If you've fixed a bug or added code that should be tested, add tests!
19-
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
20-
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](<https://github.com/>nf-core/rnaseq/tree/master/.github/CONTRIBUTING.md)
19+
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/rnaseq/tree/master/.github/CONTRIBUTING.md)
2120
- [ ] If necessary, also make a PR on the nf-core/rnaseq _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
2221
- [ ] Make sure your code lints (`nf-core lint .`).
2322
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).

.github/workflows/awsfulltest.yml

Lines changed: 20 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,34 @@
11
name: nf-core AWS full size tests
22
# This workflow is triggered on published releases.
3-
# It can be additionally triggered manually with GitHub actions workflow dispatch.
3+
# It can be additionally triggered manually with GitHub actions workflow dispatch button.
44
# It runs the -profile 'test_full' on AWS batch
55

66
on:
7-
workflow_run:
8-
workflows: ["nf-core Docker push (release)"]
9-
types: [completed]
7+
release:
8+
types: [published]
109
workflow_dispatch:
11-
12-
13-
env:
14-
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
15-
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
16-
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }}
17-
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }}
18-
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
19-
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
20-
21-
2210
jobs:
23-
run-awstest:
11+
run-tower:
2412
name: Run AWS full tests
2513
if: github.repository == 'nf-core/rnaseq'
2614
runs-on: ubuntu-latest
2715
steps:
28-
- name: Setup Miniconda
29-
uses: conda-incubator/setup-miniconda@v2
30-
with:
31-
auto-update-conda: true
32-
python-version: 3.7
33-
- name: Install awscli
34-
run: conda install -c conda-forge awscli
35-
- name: Start AWS batch job
16+
- name: Launch workflow via tower
17+
uses: nf-core/tower-action@master
3618
# TODO nf-core: You can customise AWS full pipeline tests as required
3719
# Add full size test data (but still relatively small datasets for few samples)
3820
# on the `test_full.config` test runs with only one set of parameters
39-
# Then specify `-profile test_full` instead of `-profile test` on the AWS batch command
40-
run: |
41-
aws batch submit-job \
42-
--region eu-west-1 \
43-
--job-name nf-core-rnaseq \
44-
--job-queue $AWS_JOB_QUEUE \
45-
--job-definition $AWS_JOB_DEFINITION \
46-
--container-overrides '{"command": ["nf-core/rnaseq", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/rnaseq/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/rnaseq/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}'
21+
22+
with:
23+
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
24+
bearer_token: ${{ secrets.TOWER_BEARER_TOKEN }}
25+
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
26+
pipeline: ${{ github.repository }}
27+
revision: ${{ github.sha }}
28+
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/rnaseq/work-${{ github.sha }}
29+
parameters: |
30+
{
31+
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/rnaseq/results-${{ github.sha }}"
32+
}
33+
profiles: '[ "test_full", "aws_tower" ]'
34+

.github/workflows/awstest.yml

Lines changed: 18 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,28 @@
11
name: nf-core AWS test
2-
# This workflow is triggered on push to the master branch.
3-
# It can be additionally triggered manually with GitHub actions workflow dispatch.
4-
# It runs the -profile 'test' on AWS batch.
2+
# This workflow can be triggered manually with the GitHub actions workflow dispatch button.
3+
# It runs the -profile 'test' on AWS batch
54

65
on:
76
workflow_dispatch:
8-
9-
10-
env:
11-
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
12-
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
13-
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }}
14-
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }}
15-
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
16-
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
17-
18-
197
jobs:
20-
run-awstest:
8+
run-tower:
219
name: Run AWS tests
2210
if: github.repository == 'nf-core/rnaseq'
2311
runs-on: ubuntu-latest
2412
steps:
25-
- name: Setup Miniconda
26-
uses: conda-incubator/setup-miniconda@v2
13+
- name: Launch workflow via tower
14+
uses: nf-core/tower-action@master
15+
2716
with:
28-
auto-update-conda: true
29-
python-version: 3.7
30-
- name: Install awscli
31-
run: conda install -c conda-forge awscli
32-
- name: Start AWS batch job
33-
# TODO nf-core: You can customise CI pipeline run tests as required
34-
# For example: adding multiple test runs with different parameters
35-
# Remember that you can parallelise this by using strategy.matrix
36-
run: |
37-
aws batch submit-job \
38-
--region eu-west-1 \
39-
--job-name nf-core-rnaseq \
40-
--job-queue $AWS_JOB_QUEUE \
41-
--job-definition $AWS_JOB_DEFINITION \
42-
--container-overrides '{"command": ["nf-core/rnaseq", "-r '"${GITHUB_SHA}"' -profile test --outdir s3://'"${AWS_S3_BUCKET}"'/rnaseq/results-'"${GITHUB_SHA}"' -w s3://'"${AWS_S3_BUCKET}"'/rnaseq/work-'"${GITHUB_SHA}"' -with-tower"], "environment": [{"name": "TOWER_ACCESS_TOKEN", "value": "'"$TOWER_ACCESS_TOKEN"'"}]}'
17+
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
18+
bearer_token: ${{ secrets.TOWER_BEARER_TOKEN }}
19+
compute_env: ${{ secrets.TOWER_COMPUTE_ENV }}
20+
pipeline: ${{ github.repository }}
21+
revision: ${{ github.sha }}
22+
workdir: s3://${{ secrets.AWS_S3_BUCKET }}/work/rnaseq/work-${{ github.sha }}
23+
parameters: |
24+
{
25+
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/rnaseq/results-${{ github.sha }}"
26+
}
27+
profiles: '[ "test", "aws_tower" ]'
28+

.github/workflows/ci.yml

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,28 +23,11 @@ jobs:
2323
strategy:
2424
matrix:
2525
# Nextflow versions: check pipeline minimum and current latest
26-
nxf_ver: ['20.04.0', '']
26+
nxf_ver: ['21.04.0', '']
2727
steps:
2828
- name: Check out pipeline code
2929
uses: actions/checkout@v2
3030

31-
- name: Check if Dockerfile or Conda environment changed
32-
uses: technote-space/get-diff-action@v4
33-
with:
34-
FILES: |
35-
Dockerfile
36-
environment.yml
37-
38-
- name: Build new docker image
39-
if: env.MATCHED_FILES
40-
run: docker build --no-cache . -t nfcore/rnaseq:dev
41-
42-
- name: Pull docker image
43-
if: ${{ !env.MATCHED_FILES }}
44-
run: |
45-
docker pull nfcore/rnaseq:dev
46-
docker tag nfcore/rnaseq:dev nfcore/rnaseq:dev
47-
4831
- name: Install Nextflow
4932
env:
5033
CAPSULE_LOG: none

.github/workflows/linting.yml

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Install markdownlint
1919
run: npm install -g markdownlint-cli
2020
- name: Run Markdownlint
21-
run: markdownlint ${GITHUB_WORKSPACE} -c ${GITHUB_WORKSPACE}/.github/markdownlint.yml
21+
run: markdownlint .
2222

2323
# If the above check failed, post a comment on the PR explaining the failure
2424
- name: Post PR comment
@@ -35,8 +35,8 @@ jobs:
3535
* On Mac: `brew install markdownlint-cli`
3636
* Everything else: [Install `npm`](https://www.npmjs.com/get-npm) then [install `markdownlint-cli`](https://www.npmjs.com/package/markdownlint-cli) (`npm install -g markdownlint-cli`)
3737
* Fix the markdown errors
38-
* Automatically: `markdownlint . --config .github/markdownlint.yml --fix`
39-
* Manually resolve anything left from `markdownlint . --config .github/markdownlint.yml`
38+
* Automatically: `markdownlint . --fix`
39+
* Manually resolve anything left from `markdownlint .`
4040
4141
Once you push these changes the test should pass, and you can hide this comment :+1:
4242
@@ -46,6 +46,20 @@ jobs:
4646
repo-token: ${{ secrets.GITHUB_TOKEN }}
4747
allow-repeats: false
4848

49+
EditorConfig:
50+
runs-on: ubuntu-latest
51+
steps:
52+
- uses: actions/checkout@v2
53+
54+
- uses: actions/setup-node@v1
55+
with:
56+
node-version: "10"
57+
58+
- name: Install editorconfig-checker
59+
run: npm install -g editorconfig-checker
60+
61+
- name: Run ECLint check
62+
run: editorconfig-checker -exclude README.md $(git ls-files | grep -v test)
4963

5064
YAML:
5165
runs-on: ubuntu-latest
@@ -84,7 +98,6 @@ jobs:
8498
repo-token: ${{ secrets.GITHUB_TOKEN }}
8599
allow-repeats: false
86100

87-
88101
nf-core:
89102
runs-on: ubuntu-latest
90103
steps:

.github/workflows/push_dockerhub_dev.yml

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/workflows/push_dockerhub_release.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)