Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev -> Master 2.7.0 #420

Merged
merged 198 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from 196 commits
Commits
Show all changes
198 commits
Select commit Hold shift + click to select a range
8e41534
post-release version bump
sateeshperi Jan 6, 2024
07272a2
post-release changelog update
sateeshperi Jan 6, 2024
80bb0a4
Merge pull request #371 from sateeshperi/dev
edmundmiller Jan 6, 2024
b13d033
Update awsfulltest.yml
sateeshperi Jan 16, 2024
2ff2a09
Template update for nf-core/tools version 2.12
nf-core-bot Jan 29, 2024
56bc60c
Merge branch 'dev' into nf-core-template-merge-2.12
edmundmiller Feb 10, 2024
218f1da
chore(2.12): Bump snapshots
edmundmiller Feb 10, 2024
0c0a81b
ci: Only use pipeline tests
edmundmiller Feb 10, 2024
21fadbf
fix linting
sateeshperi Feb 11, 2024
a3be34c
update .nf-core.yml to disable a file exist check
sateeshperi Feb 11, 2024
90c63ba
update path to pipeline test files
sateeshperi Feb 11, 2024
b9ca80e
Merge pull request #377 from nf-core/nf-core-template-merge-2.12
edmundmiller Feb 11, 2024
4aec0fd
Template update for nf-core/tools version 2.13
nf-core-bot Feb 20, 2024
1a9d087
fix sample names _ join + update bismark tests, snap
sateeshperi Feb 21, 2024
457f9d6
update bismark_hisat2 & bwameth tests and snap
sateeshperi Feb 22, 2024
1faa12b
Merge pull request #381 from nf-core/fix/samplename-join
edmundmiller Feb 23, 2024
0d0395e
Merge branch 'dev' of github.com:nf-core/methylseq into nf-core-templ…
edmundmiller Feb 28, 2024
75e47be
test: Update versions.yml path
edmundmiller Feb 27, 2024
c6176ef
style: Pick a lane on comment style
edmundmiller Feb 20, 2024
664ff42
fix: Remove ifEmpty(null)
edmundmiller Feb 28, 2024
3b5356d
Merge pull request #380 from nf-core/nf-core-template-merge-2.13
edmundmiller Feb 28, 2024
4fc19f5
Template update for nf-core/tools version 2.13.1
nf-core-bot Feb 29, 2024
47fc92f
Merge branch 'dev' into nf-core-template-merge-2.13.1
edmundmiller Feb 29, 2024
ee3a02c
Merge pull request #384 from nf-core/nf-core-template-merge-2.13.1
edmundmiller Feb 29, 2024
80b76f5
remove duplicate section from usage.md
fbnrst Mar 1, 2024
16dc6dd
Merge pull request #386 from fbnrst/patch-2
FelixKrueger Mar 21, 2024
30c76b5
test(#392): Add boilerplate for tests
edmundmiller Mar 29, 2024
825d441
Update samplesheet.csv
FelixKrueger Mar 30, 2024
86b4f7b
Update samplesheet.csv
FelixKrueger Apr 4, 2024
880e473
fix paths
maxulysse Apr 4, 2024
94a3856
fix: fix path to script
maxulysse Apr 4, 2024
7e0f7ff
Template update for nf-core/tools version 2.14.0
nf-core-bot May 8, 2024
76a963b
Template update for nf-core/tools version 2.14.1
nf-core-bot May 9, 2024
21499e8
fix single multiple fastq branching
sateeshperi May 16, 2024
d51f106
use validateInputSamplesheet function
sateeshperi May 17, 2024
dbe0715
move getGenomeAttribute to main
sateeshperi May 17, 2024
4046aa6
add test_data to schemaignore to remove warning
maxulysse May 17, 2024
3256eb9
remove getGenomeAttribute usage for files not in iGenomes
maxulysse May 17, 2024
4648f90
Merge branch 'dev' into nf-core-template-merge-2.14.1
maxulysse May 17, 2024
9edcbfe
prettier
maxulysse May 17, 2024
d0a510f
fix linting
maxulysse May 17, 2024
7fd5db0
Update main.nf
maxulysse May 17, 2024
dfd2a90
no need to disable that
maxulysse May 17, 2024
c053098
disable that
maxulysse May 17, 2024
2f9d39a
Merge pull request #399 from nf-core/nf-core-template-merge-2.14.1
maxulysse May 17, 2024
88a6ca8
Merge branch 'dev' into fix/sample-merge
maxulysse May 17, 2024
dbd8b43
no need for that
maxulysse May 17, 2024
1b18351
Merge pull request #401 from nf-core/fix/sample-merge
maxulysse May 17, 2024
d1c5d0e
Merge branch 'dev' into fix/tech-reps
maxulysse May 17, 2024
f36cbdf
add very simple tests
maxulysse May 17, 2024
ac0b3c9
Merge pull request #393 from nf-core/fix/tech-reps
FelixKrueger May 17, 2024
3f07b0f
fix usage of fasta references
maxulysse May 28, 2024
e72476b
update contributors
maxulysse May 28, 2024
d38c4b1
update CHANGELOG
maxulysse May 28, 2024
32297ea
Merge pull request #403 from maxulysse/fasta_references
maxulysse May 28, 2024
1021052
Bump preseq
ewels Mar 22, 2024
084e264
chore: Update CHANGELOG
edmundmiller Jun 28, 2024
ce40e8d
fixup! Bump preseq
edmundmiller Jun 28, 2024
36f8470
Merge pull request #390 from ewels/bump-preseq
edmundmiller Jun 28, 2024
d88f89a
all module updates
sateeshperi Sep 2, 2024
ddaf8b3
update wf channels to match module updates
sateeshperi Sep 2, 2024
34ddc79
fix bwameth fasta value ch by remapping
sateeshperi Sep 2, 2024
982e7b2
update pipeline test snapshots
sateeshperi Sep 2, 2024
d168cf3
add bwameth-align methyldackel tests and add GRCh37,8 bwameth igenome…
sateeshperi Sep 5, 2024
2bffd87
move prepare genome to main
sateeshperi Sep 5, 2024
3dbc090
fix ch_bwameth_index assign bug in prepare genome
sateeshperi Sep 5, 2024
77f2f75
rm fasta and index init from nextflow.config
sateeshperi Sep 6, 2024
29c4dfd
update samtools/faidx inputs
sateeshperi Sep 6, 2024
7b276c9
reorg modules.config to separate configs and module updates
sateeshperi Sep 6, 2024
03967bd
reorg sub-wf folders
sateeshperi Sep 6, 2024
33891bd
rm modules.config and harshil align
sateeshperi Sep 6, 2024
b0d03cb
update .nf-core.yml, ignore modules.config
sateeshperi Sep 6, 2024
1da66a1
nf-core sub-wf update
sateeshperi Sep 6, 2024
5f1a2cd
update tests organization
sateeshperi Sep 7, 2024
a163515
add bismark dump tags
sateeshperi Sep 7, 2024
34ea759
move fasta_index ch creation out of bwameth scope
sateeshperi Sep 8, 2024
725d0ea
prepare_genome local sub-wf tests
sateeshperi Sep 8, 2024
1e8aff2
mv fasta_index to bwameth scope and update tests
sateeshperi Sep 8, 2024
5967bd0
separate sub-wf configs
sateeshperi Sep 8, 2024
f83b3c3
bismark local sub-wf test
sateeshperi Sep 8, 2024
f9d9866
bwameth local sub-wf test
sateeshperi Sep 9, 2024
8e4befd
Update .gitpod.yml
sateeshperi Sep 9, 2024
8098992
pipeline level test snaps
sateeshperi Sep 9, 2024
0cac2e6
update gitpod base to dev
sateeshperi Sep 9, 2024
3ffcd77
test: Skip deduplication
edmundmiller Sep 9, 2024
82573ea
fix: Update syntax to deal with the meta ids
edmundmiller Sep 9, 2024
da15afd
update bwameth local sub-wf test
sateeshperi Sep 9, 2024
3c66d2d
rnaseq ci gha workflow copy
sateeshperi Sep 10, 2024
d2a5273
CI: try nf-test shard from nascent
sateeshperi Sep 10, 2024
652dd9a
CI: --changed-until workflow-updates & add nf-test ci triggers for fu…
sateeshperi Sep 10, 2024
19a9ddf
changed-until from dev
sateeshperi Sep 10, 2024
1b47f8b
CI: changed-until feat/workflow-updates
sateeshperi Sep 10, 2024
a2a7967
Add length_trim parameter to nextflow.config file
Sep 15, 2024
1a10da6
Update CHANGELOG
geethavenk Sep 16, 2024
5af05d6
Update nextflow schema
geethavenk Sep 17, 2024
fc4f665
Merge pull request #416 from geethavenk/add_trimgalore_param
sateeshperi Sep 17, 2024
27a97c2
rm igenomes bwameth_index use
sateeshperi Sep 18, 2024
6b06c1e
update samtools mutliqc modules
sateeshperi Sep 18, 2024
916a47a
update test snaps after samtools update
sateeshperi Sep 18, 2024
428ae98
use nft-bam plugin - init default
sateeshperi Sep 19, 2024
c726471
update UTILS.groovy and snaps
sateeshperi Sep 19, 2024
1e36141
added type field to entry in nextflow_schema.json to address issue #361
scoughlan2 Sep 20, 2024
663b0aa
update CHANGELOG.md
scoughlan2 Sep 20, 2024
785ca56
fix bismark samtools_sort overwrite #328
sateeshperi Sep 21, 2024
7b2f2fe
bwameth samtool_index capture only index
sateeshperi Sep 21, 2024
92a4b70
update pipeline default test snap
sateeshperi Sep 21, 2024
a8cce4e
add save_align_intermeds test snap
sateeshperi Sep 21, 2024
6211ce4
module meta updates
sateeshperi Sep 21, 2024
bb87872
Merge branch 'feat/workflow-updates' into dev
sateeshperi Sep 21, 2024
a35d608
Merge pull request #417 from scoughlan2/dev
sateeshperi Sep 21, 2024
a02aa68
separate bismark tests
sateeshperi Sep 21, 2024
63e4153
add dedup samtools_index step and update default test
sateeshperi Sep 22, 2024
b837413
add UTILS_PIPELINE.groovy and semi-automate pipeline level tests and …
sateeshperi Sep 22, 2024
8ddcf6d
update pipeline level tests and snaps
sateeshperi Sep 22, 2024
471d45d
update workflow trace size assert and test configs + CHANGELOG
sateeshperi Sep 23, 2024
0cedbce
Update workflows/methylseq/main.nf
sateeshperi Sep 23, 2024
3f19e77
Merge pull request #414 from nf-core/feat/workflow-updates
sateeshperi Sep 23, 2024
918bc03
fix samplesheet syntax in README and usage docs
sateeshperi Sep 27, 2024
c31c9b5
samtools modules env update
sateeshperi Sep 27, 2024
c0b084e
update Ecoli sample name, docs, usage, snaps
sateeshperi Sep 27, 2024
b3ee70c
CI: increase to 5 shards and changed-since HEAD^
sateeshperi Sep 27, 2024
0f2dad7
Merge pull request #418 from nf-core/fix/README-391
sateeshperi Sep 27, 2024
d03523a
bump-version and update CHANGELOG
sateeshperi Sep 27, 2024
c201e1d
update snaps for release 2.7.0
sateeshperi Sep 29, 2024
cee7d7a
limit CI to pipeline level tests and add missing bismark_hisat sub-wf…
sateeshperi Sep 29, 2024
fb21dff
Merge branch 'nf-core:dev' into dev
sateeshperi Sep 29, 2024
728db89
Merge pull request #419 from sateeshperi/dev
sateeshperi Sep 30, 2024
c5c90fa
Merge branch 'master' into dev
sateeshperi Sep 30, 2024
9afe15b
update date for 2.7.0 release
sateeshperi Oct 1, 2024
481c2b1
Merge pull request #421 from sateeshperi/dev
sateeshperi Oct 1, 2024
bcdf67d
Template update for nf-core/tools version 3.0.0
nf-core-bot Oct 8, 2024
8fcee3e
Template update for nf-core/tools version 3.0.1
nf-core-bot Oct 9, 2024
b14443d
nf-core-template-merge-3.0.1
sateeshperi Oct 10, 2024
7869252
update samplesheet and fastq ch flow after 3.0.1 template update
sateeshperi Oct 11, 2024
79b8df1
update fastq ch creation from utils_nf_core_methylseq sub-wf
sateeshperi Oct 11, 2024
90a0074
add resourceLimits to test_full too
sateeshperi Oct 11, 2024
d0a3902
Template update for nf-core/tools version 3.0.2
nf-core-bot Oct 11, 2024
c3c166a
template update tools v3.0.2
sateeshperi Oct 11, 2024
2533c60
template update tools v3.0.2
sateeshperi Oct 11, 2024
c7b6bb9
samtools/sort update and update changelog
sateeshperi Oct 11, 2024
fa55357
CI: add fetch-depth for nf-test changed-since setting
sateeshperi Oct 12, 2024
6a3300d
update nft-utils 0.0.3, add .nftignore and regen snaps
sateeshperi Oct 12, 2024
9ee8af6
update bwameth snap
sateeshperi Oct 12, 2024
2ec618e
Update CITATIONS.md
sateeshperi Oct 14, 2024
42f3485
Update CITATIONS.md
sateeshperi Oct 14, 2024
b6e87b5
add publish test report CI step
sateeshperi Oct 14, 2024
00e0613
Merge pull request #426 from sateeshperi/dev
sateeshperi Oct 14, 2024
dc9b031
update bismark+bwameth modules; sub-wf; wf - fasta file staged separe…
sateeshperi Oct 17, 2024
c02aad8
update snaps after modules update
sateeshperi Oct 17, 2024
ba87373
update changelog
sateeshperi Oct 17, 2024
ed9fb74
Merge pull request #428 from sateeshperi/dev
sateeshperi Oct 17, 2024
a2a3e67
udpate tests to use nft-bam for bam files
sateeshperi Oct 17, 2024
39621af
Merge branch 'dev' into dev
sateeshperi Oct 17, 2024
58b1efe
Merge pull request #429 from sateeshperi/dev
sateeshperi Oct 17, 2024
c8e3ccd
update SAMTOOLS_FAIDX fasta input after reorg
sateeshperi Oct 17, 2024
0b83720
Merge pull request #430 from sateeshperi/dev
sateeshperi Oct 17, 2024
fb5968c
apply code review suggestions and activate igenomes bwameth index use
sateeshperi Oct 18, 2024
dd43ee1
update LICENSE after authors update
sateeshperi Oct 18, 2024
0e05c21
use igenomes fasta_index
sateeshperi Oct 18, 2024
c9729e4
Merge pull request #431 from sateeshperi/dev
sateeshperi Oct 18, 2024
c67b35c
update sub-wf tests after modules updates
sateeshperi Oct 20, 2024
3fa4a6e
fix typo in prepare_genome bismark_hisat test
sateeshperi Oct 20, 2024
4b2e64b
fix bwameth in ch order and turn on CI tests for pipeline & workflow
sateeshperi Oct 20, 2024
465be1c
fix bismark, bwameth align modules * other module updates + update snaps
sateeshperi Oct 21, 2024
a04271d
update sub-wf snap
sateeshperi Oct 21, 2024
0f930ac
Merge pull request #432 from sateeshperi/dev
sateeshperi Oct 21, 2024
101fed4
update CI and Changelog
sateeshperi Oct 22, 2024
314fb8f
update README with 2 diff options for bismark align
sateeshperi Oct 22, 2024
ad2b289
update CI matrix options
sateeshperi Oct 22, 2024
25061bf
Merge pull request #433 from sateeshperi/dev
sateeshperi Oct 22, 2024
e6fc384
update spacing in nextflow.config to test nf-test trigger
sateeshperi Oct 22, 2024
6f3beec
update CI
sateeshperi Oct 22, 2024
bafe246
Merge pull request #434 from sateeshperi/dev
sateeshperi Oct 22, 2024
f697ae4
rm conda from CI tests until the file lock resolution
sateeshperi Oct 22, 2024
80147c3
Merge pull request #435 from sateeshperi/dev
sateeshperi Oct 22, 2024
8de43e6
Add files via upload
Shaun-Regenbaum Oct 22, 2024
d9c8b35
updated metromap with sections
Shaun-Regenbaum Oct 22, 2024
ff3ef1a
Create metromap.svg
Shaun-Regenbaum Oct 22, 2024
6e9bace
override
Shaun-Regenbaum Oct 22, 2024
112bf74
Corrected Link
Shaun-Regenbaum Oct 22, 2024
3014c3d
rm resourceLimits for test_full profile
sateeshperi Oct 22, 2024
90c1cc1
using sublink for image in README
Shaun-Regenbaum Oct 22, 2024
a4c83b1
Merge pull request #438 from Shaun-Regenbaum/dev
FelixKrueger Oct 22, 2024
d17aad1
Merge branch 'dev' into dev
sateeshperi Oct 22, 2024
e3dcfd1
Merge pull request #439 from sateeshperi/dev
sateeshperi Oct 22, 2024
756ac0e
update changelog and readme
sateeshperi Oct 23, 2024
045da37
Merge pull request #442 from sateeshperi/dev
sateeshperi Oct 23, 2024
007e23b
Update metromap.svg
ewels Oct 23, 2024
1befdff
Delete docs/images/metromap.png
ewels Oct 23, 2024
a56b67a
Add updated metromap png
ewels Oct 23, 2024
6a65849
Merge pull request #443 from nf-core/metromap-update
sateeshperi Oct 23, 2024
d7578f0
fix awsfulltest
mashehu Oct 23, 2024
e03bc46
add hisat2 bismark index to igenomes
sateeshperi Oct 23, 2024
5e7fca3
update changelog
sateeshperi Oct 23, 2024
96fb9ec
Update CHANGELOG.md
sateeshperi Oct 23, 2024
0bbf07f
Merge pull request #444 from sateeshperi/dev
sateeshperi Oct 23, 2024
58219d5
apply suggestions from nextflow vscode formatter + update date in cha…
sateeshperi Oct 24, 2024
cd1a02f
Merge pull request #445 from sateeshperi/dev
sateeshperi Oct 25, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 1 addition & 9 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,7 @@
"vscode": {
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/opt/conda/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/opt/conda/bin/autopep8",
"python.formatting.yapfPath": "/opt/conda/bin/yapf",
"python.linting.flake8Path": "/opt/conda/bin/flake8",
"python.linting.pycodestylePath": "/opt/conda/bin/pycodestyle",
"python.linting.pydocstylePath": "/opt/conda/bin/pydocstyle",
"python.linting.pylintPath": "/opt/conda/bin/pylint"
"python.defaultInterpreterPath": "/opt/conda/bin/python"
},

// Add the IDs of extensions you want installed when the container is created.
Expand Down
11 changes: 10 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
indent_size = unset
[/subworkflows/nf-core/**]
charset = unset
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset

[/assets/email*]
indent_size = unset

# ignore python and markdown
[*.{py,md}]
indent_style = unset
26 changes: 14 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ 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 ;)

:::info
If you need help using or modifying nf-core/methylseq then the best place to ask is on the nf-core Slack [#methylseq](https://nfcore.slack.com/channels/methylseq) channel ([join our Slack here](https://nf-co.re/join/slack)).
:::
> [!NOTE]
> If you need help using or modifying nf-core/methylseq then the best place to ask is on the nf-core Slack [#methylseq](https://nfcore.slack.com/channels/methylseq) channel ([join our Slack here](https://nf-co.re/join/slack)).

## Contribution workflow

Expand All @@ -20,15 +19,18 @@ If you'd like to write some code for nf-core/methylseq, the standard workflow is
1. Check that there isn't already an issue about your idea in the [nf-core/methylseq issues](https://github.com/nf-core/methylseq/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/methylseq repository](https://github.com/nf-core/methylseq) to your GitHub account
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
4. Use `nf-core schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
4. Use `nf-core pipelines schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
5. 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

You can optionally test your changes by running the pipeline locally. Then it is recommended to use the `debug` profile to
receive warnings about process selectors and other debug info. Example: `nextflow run . -profile debug,test,docker --outdir <OUTDIR>`.
You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command:

```bash
nf-test test --profile debug,test,docker --verbose
```

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.
Expand All @@ -38,7 +40,7 @@ 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.
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 pipelines lint <pipeline-directory>` command.

If any failures or warnings are encountered, please follow the listed URL for more documentation.

Expand Down Expand Up @@ -73,7 +75,7 @@ If you wish to contribute a new step, please use the following coding standards:
2. Write the process block (see below).
3. Define the output channel if needed (see below).
4. Add any new parameters to `nextflow.config` with a default (see below).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core schema build` tool).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
6. Add sanity checks and validation for all relevant parameters.
7. Perform local tests to validate that the new code works as expected.
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
Expand All @@ -84,13 +86,13 @@ If you wish to contribute a new step, please use the following coding standards:

Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope.

Once there, use `nf-core schema build` to add to `nextflow_schema.json`.
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.

### Default processes resource requirements

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.
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/main/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.

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.
The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.

### Naming schemes

Expand All @@ -101,7 +103,7 @@ Please use the following naming schemes, to make it easy to understand what is g

### Nextflow version bumping

If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core bump-version --nextflow . [min-nf-version]`
If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core pipelines bump-version --nextflow . [min-nf-version]`

### Images and figures

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/meth
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/methylseq/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/methylseq _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Make sure your code lints (`nf-core pipelines lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
Expand Down
40 changes: 29 additions & 11 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,40 @@
name: nf-core AWS full size tests
# This workflow is triggered on published releases.
# This workflow is triggered on PRs opened against the master branch.
# It can be additionally triggered manually with GitHub actions workflow dispatch button.
# It runs the -profile 'test_full' on AWS batch

on:
release:
types: [published]
pull_request:
branches:
- master
workflow_dispatch:
pull_request_review:
types: [submitted]

jobs:
run-tower:
run-platform:
name: Run AWS full tests
if: github.repository == 'nf-core/methylseq'
# run only if the PR is approved by at least 2 reviewers and against the master branch or manually triggered
if: github.repository == 'nf-core/methylseq' && github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'master' || github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
strategy:
matrix:
aligner: ["bismark", "bismark_hisat", "bwameth"]
steps:
- name: Launch workflow via tower
- uses: octokit/[email protected]
if: github.event_name != 'workflow_dispatch'
id: check_approvals
with:
route: GET /repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews?per_page=100
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- id: test_variables
if: github.event_name != 'workflow_dispatch'
run: |
JSON_RESPONSE='${{ steps.check_approvals.outputs.data }}'
CURRENT_APPROVALS_COUNT=$(echo $JSON_RESPONSE | jq -c '[.[] | select(.state | contains("APPROVED")) ] | length')
test $CURRENT_APPROVALS_COUNT -ge 2 || exit 1 # At least 2 approvals are required
- name: Launch workflow via Seqera Platform
uses: seqeralabs/action-tower-launch@v2
with:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
Expand All @@ -27,14 +45,14 @@ jobs:
parameters: |
{
"hook_url": "${{ secrets.MEGATESTS_ALERTS_SLACK_HOOK_URL }}",
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/methylseq/results-${{ github.sha }}/${{matrix.aligner}}"
"outdir": "s3://${{ secrets.AWS_S3_BUCKET }}/methylseq/results-${{ github.sha }}/${{matrix.aligner}}",
"aligner": "${{ matrix.aligner }}",
}
profiles: test_full

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
name: Tower debug log file
name: Seqera Platform debug log file
path: |
tower_action_*.log
tower_action_*.json
seqera_platform_action_*.log
seqera_platform_action_*.json
14 changes: 7 additions & 7 deletions .github/workflows/awstest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ name: nf-core AWS test
on:
workflow_dispatch:
jobs:
run-tower:
run-platform:
name: Run AWS tests
if: github.repository == 'nf-core/methylseq'
runs-on: ubuntu-latest
strategy:
matrix:
aligner: ["bismark", "bismark_hisat", "bwameth"]
steps:
# Launch workflow using Tower CLI tool action
- name: Launch workflow via tower
# Launch workflow using Seqera Platform CLI tool action
- name: Launch workflow via Seqera Platform
uses: seqeralabs/action-tower-launch@v2
with:
workspace_id: ${{ secrets.TOWER_WORKSPACE_ID }}
Expand All @@ -29,9 +29,9 @@ jobs:
}
profiles: test

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
with:
name: Tower debug log file
name: Seqera Platform debug log file
path: |
tower_action_*.log
tower_action_*.json
seqera_platform_action_*.log
seqera_platform_action_*.json
2 changes: 1 addition & 1 deletion .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
# 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
uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc # v2
with:
message: |
## This PR is against the `master` branch :x:
Expand Down
Loading
Loading