Skip to content

Commit f35398d

Browse files
committed
Template update for nf-core/tools version 1.13
1 parent f690b89 commit f35398d

30 files changed

+871
-176
lines changed

.github/.dockstore.yml

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ version: 1.2
33
workflows:
44
- subclass: nfl
55
primaryDescriptorPath: /nextflow.config
6+
publish: True

.github/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ If you wish to contribute a new step, please use the following coding standards:
6969
2. Write the process block (see below).
7070
3. Define the output channel if needed (see below).
7171
4. Add any new flags/options to `nextflow.config` with a default (see below).
72-
5. Add any new flags/options to `nextflow_schema.json` with help text (with `nf-core schema build .`)
72+
5. Add any new flags/options to `nextflow_schema.json` with help text (with `nf-core schema build .`).
7373
6. Add any new flags/options to the help message (for integer/text parameters, print to help the corresponding `nextflow.config` parameter).
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`.
@@ -87,7 +87,7 @@ Once there, use `nf-core schema build .` to add to `nextflow_schema.json`.
8787

8888
### Default processes resource requirements
8989

90-
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/%7B%7Bcookiecutter.name_noslash%7D%7D/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
90+
Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.
9191

9292
The process resources can be passed on to the tool dynamically within the process with the `${task.cpu}` and `${task.memory}` variables in the `script:` block.
9393

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Have you provided the following extra information/files:
5555

5656
## Container engine
5757

58-
- Engine: <!-- [e.g. Conda, Docker, Singularity or Podman] -->
58+
- Engine: <!-- [e.g. Conda, Docker, Singularity, Podman, Shifter or Charliecloud] -->
5959
- version: <!-- [e.g. 1.0.0] -->
6060
- Image tag: <!-- [e.g. nfcore/rnaseq:1.0.0] -->
6161

.github/ISSUE_TEMPLATE/feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for the nf-core website
3+
about: Suggest an idea for the nf-core/rnaseq pipeline
44
labels: enhancement
55
---
66

.github/PULL_REQUEST_TEMPLATE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnas
1515

1616
- [ ] This comment contains a description of changes (with reason).
1717
- [ ] If you've fixed a bug or added code that should be tested, add tests!
18-
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
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)
20-
- [ ] 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.
18+
- [ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
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)
20+
- [ ] 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.
2121
- [ ] Make sure your code lints (`nf-core lint .`).
2222
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
2323
- [ ] Usage Documentation in `docs/usage.md` is updated.

.github/workflows/awsfulltest.yml

+10-7
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ on:
99
types: [completed]
1010
workflow_dispatch:
1111

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+
1222
jobs:
1323
run-awstest:
1424
name: Run AWS full tests
@@ -27,13 +37,6 @@ jobs:
2737
# Add full size test data (but still relatively small datasets for few samples)
2838
# on the `test_full.config` test runs with only one set of parameters
2939
# Then specify `-profile test_full` instead of `-profile test` on the AWS batch command
30-
env:
31-
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
32-
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
33-
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }}
34-
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }}
35-
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
36-
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
3740
run: |
3841
aws batch submit-job \
3942
--region eu-west-1 \

.github/workflows/awstest.yml

+10-7
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ name: nf-core AWS test
66
on:
77
workflow_dispatch:
88

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+
919
jobs:
1020
run-awstest:
1121
name: Run AWS tests
@@ -23,13 +33,6 @@ jobs:
2333
# TODO nf-core: You can customise CI pipeline run tests as required
2434
# For example: adding multiple test runs with different parameters
2535
# Remember that you can parallelise this by using strategy.matrix
26-
env:
27-
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
28-
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
29-
TOWER_ACCESS_TOKEN: ${{ secrets.AWS_TOWER_TOKEN }}
30-
AWS_JOB_DEFINITION: ${{ secrets.AWS_JOB_DEFINITION }}
31-
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
32-
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
3336
run: |
3437
aws batch submit-job \
3538
--region eu-west-1 \

.github/workflows/branch.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- name: Check PRs
1414
if: github.repository == 'nf-core/rnaseq'
1515
run: |
16-
{ [[ ${{github.event.pull_request.head.repo.full_name}} == nf-core/rnaseq ]] && [[ $GITHUB_HEAD_REF = "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
16+
{ [[ ${{github.event.pull_request.head.repo.full_name }} == nf-core/rnaseq ]] && [[ $GITHUB_HEAD_REF = "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
1717
1818
1919
# If the above check failed, post a comment on the PR explaining the failure
@@ -25,11 +25,12 @@ jobs:
2525
message: |
2626
Hi @${{ github.event.pull_request.user.login }},
2727
28-
It looks like this pull-request is has been made against the ${{github.event.pull_request.head.repo.full_name}} `master` branch.
28+
It looks like this pull-request is has been made against the ${{github.event.pull_request.base.repo.full_name }} `master` branch.
2929
The `master` branch on nf-core repositories should always contain code from the latest release.
30-
Because of this, PRs to `master` are only allowed if they come from the ${{github.event.pull_request.head.repo.full_name}} `dev` branch.
30+
Because of this, PRs to `master` are only allowed if they come from the ${{github.event.pull_request.base.repo.full_name }} `dev` branch.
3131
3232
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.
33+
Note that even after this, the test will continue to show as failing until you push a new commit.
3334
3435
Thanks again for your contribution!
3536
repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/linting.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
if: ${{ always() }}
7070
uses: actions/upload-artifact@v2
7171
with:
72-
name: linting-log-file
72+
name: linting-logs
7373
path: |
7474
lint_log.txt
7575
lint_results.md

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6-
## v2.1dev - [date]
6+
## v3.1dev - [date]
77

88
Initial release of nf-core/rnaseq, created with the [nf-core](https://nf-co.re/) template.
99

0 commit comments

Comments
 (0)