Skip to content

Commit efff19f

Browse files
committed
Template update for nf-core/tools version 2.11
1 parent 8548006 commit efff19f

32 files changed

+360
-66
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ If you're not used to this workflow with git, you can start with some [docs from
2727

2828
## Tests
2929

30+
You can optionally test your changes by running the pipeline locally. Then it is recommended to use the `debug` profile to
31+
receive warnings about process selectors and other debug info. Example: `nextflow run . -profile debug,test,docker --outdir <OUTDIR>`.
32+
3033
When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
3134
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
3235

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnas
1919
- [ ] 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.
2020
- [ ] Make sure your code lints (`nf-core lint`).
2121
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
22+
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
2223
- [ ] Usage Documentation in `docs/usage.md` is updated.
2324
- [ ] Output Documentation in `docs/output.md` is updated.
2425
- [ ] `CHANGELOG.md` is updated.

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- "latest-everything"
2929
steps:
3030
- name: Check out pipeline code
31-
uses: actions/checkout@v3
31+
uses: actions/checkout@v4
3232

3333
- name: Install Nextflow
3434
uses: nf-core/setup-nextflow@v1

.github/workflows/fix-linting.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
# Use the @nf-core-bot token to check out so we can push later
16-
- uses: actions/checkout@v3
16+
- uses: actions/checkout@v4
1717
with:
1818
token: ${{ secrets.nf_core_bot_auth_token }}
1919

@@ -24,7 +24,7 @@ jobs:
2424
env:
2525
GITHUB_TOKEN: ${{ secrets.nf_core_bot_auth_token }}
2626

27-
- uses: actions/setup-node@v3
27+
- uses: actions/setup-node@v4
2828

2929
- name: Install Prettier
3030
run: npm install -g prettier @prettier/plugin-php

.github/workflows/linting.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ jobs:
1414
EditorConfig:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/checkout@v3
17+
- uses: actions/checkout@v4
1818

19-
- uses: actions/setup-node@v3
19+
- uses: actions/setup-node@v4
2020

2121
- name: Install editorconfig-checker
2222
run: npm install -g editorconfig-checker
@@ -27,9 +27,9 @@ jobs:
2727
Prettier:
2828
runs-on: ubuntu-latest
2929
steps:
30-
- uses: actions/checkout@v3
30+
- uses: actions/checkout@v4
3131

32-
- uses: actions/setup-node@v3
32+
- uses: actions/setup-node@v4
3333

3434
- name: Install Prettier
3535
run: npm install -g prettier
@@ -40,7 +40,7 @@ jobs:
4040
PythonBlack:
4141
runs-on: ubuntu-latest
4242
steps:
43-
- uses: actions/checkout@v3
43+
- uses: actions/checkout@v4
4444

4545
- name: Check code lints with Black
4646
uses: psf/black@stable
@@ -71,7 +71,7 @@ jobs:
7171
runs-on: ubuntu-latest
7272
steps:
7373
- name: Check out pipeline code
74-
uses: actions/checkout@v3
74+
uses: actions/checkout@v4
7575

7676
- name: Install Nextflow
7777
uses: nf-core/setup-nextflow@v1

.gitpod.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ tasks:
44
command: |
55
pre-commit install --install-hooks
66
nextflow self-update
7-
7+
- name: unset JAVA_TOOL_OPTIONS
8+
command: |
9+
unset JAVA_TOOL_OPTIONS
810
vscode:
911
extensions: # based on nf-core.nf-core-extensionpack
1012
- codezombiech.gitignore # Language support for .gitignore files

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
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-
## v3.13.0dev - [date]
6+
## v3.14.0dev - [date]
77

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

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,8 @@
3030

3131
## Usage
3232

33-
:::note
34-
If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how
35-
to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline)
36-
with `-profile test` before running the workflow on actual data.
37-
:::
33+
> [!NOTE]
34+
> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.
3835
3936
<!-- TODO nf-core: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
4037
Explain what rows and columns represent. For instance (please edit as appropriate):
@@ -63,11 +60,9 @@ nextflow run nf-core/rnaseq \
6360
--outdir <OUTDIR>
6461
```
6562

66-
:::warning
67-
Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those
68-
provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
69-
see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
70-
:::
63+
> [!WARNING]
64+
> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
65+
> see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
7166
7267
For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/rnaseq/usage) and the [parameter documentation](https://nf-co.re/rnaseq/parameters).
7368

@@ -94,7 +89,7 @@ For further information or help, don't hesitate to get in touch on the [Slack `#
9489
## Citations
9590

9691
<!-- TODO nf-core: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. -->
97-
<!-- If you use nf-core/rnaseq for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->
92+
<!-- If you use nf-core/rnaseq for your analysis, please cite it using the following doi: [10.5281/zenodo.XXXXXX](https://doi.org/10.5281/zenodo.XXXXXX) -->
9893

9994
<!-- TODO nf-core: Add bibliography of tools and data used in your pipeline -->
10095

assets/multiqc_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
report_comment: >
2-
This report has been generated by the <a href="https://github.com/nf-core/rnaseq/releases/tag/dev" target="_blank">nf-core/rnaseq</a>
2+
This report has been generated by the <a href="https://github.com/nf-core/rnaseq/tree/dev" target="_blank">nf-core/rnaseq</a>
33
analysis pipeline. For information about how to interpret these results, please see the
44
<a href="https://nf-co.re/rnaseq/dev/docs/output" target="_blank">documentation</a>.
55
report_section_order:

assets/slackreport.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{
44
"fallback": "Plain-text summary of the attachment.",
55
"color": "<% if (success) { %>good<% } else { %>danger<%} %>",
6-
"author_name": "nf-core/rnaseq v${version} - ${runName}",
6+
"author_name": "nf-core/rnaseq ${version} - ${runName}",
77
"author_icon": "https://www.nextflow.io/docs/latest/_static/favicon.ico",
88
"text": "<% if (success) { %>Pipeline completed successfully!<% } else { %>Pipeline completed with errors<% } %>",
99
"fields": [

0 commit comments

Comments
 (0)