Skip to content

Commit 464df76

Browse files
committed
Template update for nf-core/tools version 3.0.2
1 parent 3708616 commit 464df76

File tree

12 files changed

+86
-58
lines changed

12 files changed

+86
-58
lines changed

.github/workflows/ci.yml

+43-17
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@ on:
1111

1212
env:
1313
NXF_ANSI_LOG: false
14+
NXF_SINGULARITY_CACHEDIR: ${{ github.workspace }}/.singularity
15+
NXF_SINGULARITY_LIBRARYDIR: ${{ github.workspace }}/.singularity
1416

1517
concurrency:
1618
group: "${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}"
1719
cancel-in-progress: true
1820

1921
jobs:
2022
test:
21-
name: Run pipeline with test data
23+
name: "Run pipeline with test data (${{ matrix.NXF_VER }} | ${{ matrix.test_name }} | ${{ matrix.profile }})"
2224
# Only run on push if this is the nf-core dev branch (merged PRs)
2325
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/scdownstream') }}"
2426
runs-on: ubuntu-latest
@@ -27,33 +29,57 @@ jobs:
2729
NXF_VER:
2830
- "24.04.2"
2931
- "latest-everything"
32+
profile:
33+
- "conda"
34+
- "docker"
35+
- "singularity"
36+
test_name:
37+
- "test"
38+
isMaster:
39+
- ${{ github.base_ref == 'master' }}
40+
# Exclude conda and singularity on dev
41+
exclude:
42+
- isMaster: false
43+
profile: "conda"
44+
- isMaster: false
45+
profile: "singularity"
3046
steps:
3147
- name: Check out pipeline code
3248
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4
3349

34-
- name: Install Nextflow
50+
- name: Set up Nextflow
3551
uses: nf-core/setup-nextflow@v2
3652
with:
3753
version: "${{ matrix.NXF_VER }}"
3854

39-
- name: Disk space cleanup
40-
uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1
55+
- name: Set up Apptainer
56+
if: matrix.profile == 'singularity'
57+
uses: eWaterCycle/setup-apptainer@main
4158

42-
- name: Run pipeline with test data (docker)
43-
# TODO nf-core: You can customise CI pipeline run tests as required
44-
# For example: adding multiple test runs with different parameters
45-
# Remember that you can parallelise this by using strategy.matrix
59+
- name: Set up Singularity
60+
if: matrix.profile == 'singularity'
4661
run: |
47-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --outdir ./results
62+
mkdir -p $NXF_SINGULARITY_CACHEDIR
63+
mkdir -p $NXF_SINGULARITY_LIBRARYDIR
64+
65+
- name: Set up Miniconda
66+
if: matrix.profile == 'conda'
67+
uses: conda-incubator/setup-miniconda@a4260408e20b96e80095f42ff7f1a15b27dd94ca # v3
68+
with:
69+
miniconda-version: "latest"
70+
auto-update-conda: true
71+
conda-solver: libmamba
72+
channels: conda-forge,bioconda
4873

49-
- name: Run pipeline with test data (singularity)
50-
# TODO nf-core: You can customise CI pipeline run tests as required
74+
- name: Set up Conda
75+
if: matrix.profile == 'conda'
5176
run: |
52-
nextflow run ${GITHUB_WORKSPACE} -profile test,singularity --outdir ./results
53-
if: "${{ github.base_ref == 'master' }}"
77+
echo $(realpath $CONDA)/condabin >> $GITHUB_PATH
78+
echo $(realpath python) >> $GITHUB_PATH
79+
80+
- name: Clean up Disk space
81+
uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1
5482

55-
- name: Run pipeline with test data (conda)
56-
# TODO nf-core: You can customise CI pipeline run tests as required
83+
- name: "Run pipeline with test data ${{ matrix.NXF_VER }} | ${{ matrix.test_name }} | ${{ matrix.profile }}"
5784
run: |
58-
nextflow run ${GITHUB_WORKSPACE} -profile test,conda --outdir ./results
59-
if: "${{ github.base_ref == 'master' }}"
85+
nextflow run ${GITHUB_WORKSPACE} -profile ${{ matrix.test_name }},${{ matrix.profile }} --outdir ./results

.github/workflows/template_version_comment.yml

+12-9
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ jobs:
1010
steps:
1111
- name: Check out pipeline code
1212
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4
13+
with:
14+
ref: ${{ github.event.pull_request.head.sha }}
1315

1416
- name: Read template version from .nf-core.yml
15-
uses: pietrobolcato/action-read-yaml@1.0.0
17+
uses: nichmor/minimal-read-yaml@v0.0.2
1618
id: read_yml
1719
with:
1820
config: ${{ github.workspace }}/.nf-core.yml
@@ -24,20 +26,21 @@ jobs:
2426
2527
- name: Check nf-core outdated
2628
id: nf_core_outdated
27-
run: pip list --outdated | grep nf-core
29+
run: echo "OUTPUT=$(pip list --outdated | grep nf-core)" >> ${GITHUB_ENV}
2830

2931
- name: Post nf-core template version comment
3032
uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc # v2
3133
if: |
32-
${{ steps.nf_core_outdated.outputs.stdout }} =~ 'nf-core'
34+
contains(env.OUTPUT, 'nf-core')
3335
with:
3436
repo-token: ${{ secrets.NF_CORE_BOT_AUTH_TOKEN }}
3537
allow-repeats: false
3638
message: |
37-
## :warning: Newer version of the nf-core template is available.
38-
39-
Your pipeline is using an old version of the nf-core template: ${{ steps.read_yml.outputs['nf_core_version'] }}.
40-
Please update your pipeline to the latest version.
41-
42-
For more documentation on how to update your pipeline, please see the [nf-core documentation](https://github.com/nf-core/tools?tab=readme-ov-file#sync-a-pipeline-with-the-template) and [Synchronisation documentation](https://nf-co.re/docs/contributing/sync).
39+
> [!WARNING]
40+
> Newer version of the nf-core template is available.
41+
>
42+
> Your pipeline is using an old version of the nf-core template: ${{ steps.read_yml.outputs['nf_core_version'] }}.
43+
> Please update your pipeline to the latest version.
44+
>
45+
> For more documentation on how to update your pipeline, please see the [nf-core documentation](https://github.com/nf-core/tools?tab=readme-ov-file#sync-a-pipeline-with-the-template) and [Synchronisation documentation](https://nf-co.re/docs/contributing/sync).
4346
#

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ results/
66
testing/
77
testing*
88
*.pyc
9+
null/

.nf-core.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
bump_version: null
22
lint: null
3-
nf_core_version: 3.0.1
3+
nf_core_version: 3.0.2
44
org_path: null
55
repository_type: pipeline
66
template:

main.nf

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ workflow {
7676
params.outdir,
7777
params.input
7878
)
79-
79+
8080
//
8181
// WORKFLOW: Run main workflow
8282
//

modules.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
"multiqc": {
1414
"branch": "master",
15-
"git_sha": "b8d36829fa84b6e404364abff787e8b07f6d058c",
15+
"git_sha": "cf17ca47590cc578dfb47db1c2a44ef86f89976d",
1616
"installed_by": ["modules"]
1717
}
1818
}
@@ -21,12 +21,12 @@
2121
"nf-core": {
2222
"utils_nextflow_pipeline": {
2323
"branch": "master",
24-
"git_sha": "9d05360da397692321d377b6102d2fb22507c6ef",
24+
"git_sha": "3aa0aec1d52d492fe241919f0c6100ebf0074082",
2525
"installed_by": ["subworkflows"]
2626
},
2727
"utils_nfcore_pipeline": {
2828
"branch": "master",
29-
"git_sha": "772684d9d66f37b650c8ba5146ac1ee3ecba2acb",
29+
"git_sha": "1b6b9a3338d011367137808b49b923515080e3ba",
3030
"installed_by": ["subworkflows"]
3131
},
3232
"utils_nfschema_plugin": {

modules/nf-core/multiqc/main.nf

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

nextflow.config

+2-2
Original file line numberDiff line numberDiff line change
@@ -254,10 +254,10 @@ validation {
254254
"""
255255
afterText = """${manifest.doi ? "* The pipeline\n" : ""}${manifest.doi.tokenize(",").collect { " https://doi.org/${it.trim().replace('https://doi.org/','')}"}.join("\n")}${manifest.doi ? "\n" : ""}
256256
* The nf-core framework
257-
https://doi.org/10.1038/s41587-020-0439-x
257+
https://doi.org/10.1038/s41587-020-0439-x
258258
259259
* Software dependencies
260-
https://github.com/${manifest.name}/blob/master/CITATIONS.md
260+
https://github.com/${manifest.name}/blob/master/CITATIONS.md
261261
"""
262262
}
263263
summary {

subworkflows/local/utils_nfcore_scdownstream_pipeline/main.nf

+1-3
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ workflow PIPELINE_INITIALISATION {
4747
workflow.profile.tokenize(',').intersect(['conda', 'mamba']).size() >= 1
4848
)
4949

50-
5150
//
5251
// Validate parameters and generate parameter summary to stdout
5352
//
@@ -56,14 +55,14 @@ workflow PIPELINE_INITIALISATION {
5655
validate_params,
5756
null
5857
)
59-
6058

6159
//
6260
// Check config provided to the pipeline
6361
//
6462
UTILS_NFCORE_PIPELINE (
6563
nextflow_cli_args
6664
)
65+
6766
//
6867
// Custom validation for pipeline parameters
6968
//
@@ -110,7 +109,6 @@ workflow PIPELINE_COMPLETION {
110109
email // string: email address
111110
email_on_fail // string: email address sent on pipeline failure
112111
plaintext_email // boolean: Send plain-text email instead of HTML
113-
114112
outdir // path: Path to output directory where results will be published
115113
monochrome_logs // boolean: Disable ANSI colour codes in log output
116114
hook_url // string: hook URL for notifications

subworkflows/nf-core/utils_nextflow_pipeline/main.nf

+16-14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

subworkflows/nf-core/utils_nfcore_pipeline/main.nf

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

workflows/scdownstream.nf

-2
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,11 @@ workflow SCDOWNSTREAM {
5757
Channel.fromPath(params.multiqc_logo, checkIfExists: true) :
5858
Channel.empty()
5959

60-
6160
summary_params = paramsSummaryMap(
6261
workflow, parameters_schema: "nextflow_schema.json")
6362
ch_workflow_summary = Channel.value(paramsSummaryMultiqc(summary_params))
6463
ch_multiqc_files = ch_multiqc_files.mix(
6564
ch_workflow_summary.collectFile(name: 'workflow_summary_mqc.yaml'))
66-
6765
ch_multiqc_custom_methods_description = params.multiqc_methods_description ?
6866
file(params.multiqc_methods_description, checkIfExists: true) :
6967
file("$projectDir/assets/methods_description_template.yml", checkIfExists: true)

0 commit comments

Comments
 (0)