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

mev -> main for 3.0.1 #3210

Merged
merged 40 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
7c1ba22
Fix comment section headers so they don't give phantom merge conflict…
jfy133 Oct 8, 2024
6e0ec01
Fix a typo in the linting action
nvnieuwk Oct 8, 2024
abc50bc
Update CHANGELOG.md
nvnieuwk Oct 8, 2024
20c23ce
[automated] Fix code linting
nf-core-bot Oct 8, 2024
27e6f49
Update CHANGELOG.md
nvnieuwk Oct 8, 2024
83eb32a
Update .gitpod.yml
nvnieuwk Oct 8, 2024
87f0dfd
Update setup.py
nvnieuwk Oct 8, 2024
0178c9f
Merge pull request #3202 from nf-core/nvnieuwk-patch-1
nvnieuwk Oct 8, 2024
0bbaead
Template: run awsfulltest only when target branch is `master`
mashehu Oct 8, 2024
c20122f
fix github variable
mashehu Oct 8, 2024
a995dbc
still allow manual dispatch
mashehu Oct 8, 2024
d00d36b
update changelog, fix if condition
mashehu Oct 8, 2024
d409c85
fix too many empty lines added to .editorconfig file
mirpedrol Oct 9, 2024
f27f796
update changelog
mirpedrol Oct 9, 2024
41052dc
Merge pull request #3203 from mashehu/fix-aws-ci
mashehu Oct 9, 2024
54a4dc5
Merge branch 'dev' into editorconfig-lines
mirpedrol Oct 9, 2024
61dec48
Merge pull request #3204 from mirpedrol/editorconfig-lines
mirpedrol Oct 9, 2024
005eaec
use correct key for defaultIgnoreParams
mashehu Oct 9, 2024
bf2c6bb
add more debugging
mashehu Oct 9, 2024
61e14c9
Revert nf-core module level subworkflow changes
jfy133 Oct 9, 2024
52eab01
Merge remote-tracking branch 'origin/dev' into fix-large-comment-head…
jfy133 Oct 9, 2024
0840f24
Update changelog
jfy133 Oct 9, 2024
530b24a
Merge pull request #3205 from mashehu/fix-ignore-params
mashehu Oct 9, 2024
d45b7d1
Merge pull request #3201 from nf-core/fix-large-comment-header-format…
jfy133 Oct 9, 2024
86a9b65
fix more jinja newlines
mirpedrol Oct 9, 2024
0113549
Update CHANGELOG.md
mirpedrol Oct 9, 2024
16a3609
Bump version to 3.0.1
mashehu Oct 9, 2024
fb952dd
update nf-core subworkflows
mirpedrol Oct 9, 2024
a4b727a
update changelog
mirpedrol Oct 9, 2024
ad32bb2
[automated] Update CHANGELOG.md
nf-core-bot Oct 9, 2024
1ce2250
fix jinja newlines in output.md
mirpedrol Oct 9, 2024
058391d
CI: fix artifact upload of snapshot report
mashehu Oct 9, 2024
85a27ad
Merge pull request #3206 from mirpedrol/jinja-newlines
mashehu Oct 9, 2024
92e2b6e
update multiqc
mashehu Oct 9, 2024
0aa1c60
update changelog
mashehu Oct 9, 2024
dd21c7b
Merge pull request #3209 from mashehu/fix-snapshot-artifact-upload
mashehu Oct 9, 2024
29fc0dc
Merge branch 'dev' into update-modules
mashehu Oct 9, 2024
f0fb3d6
update utils_nfcore_pipeline subworkflow
mirpedrol Oct 9, 2024
53655f4
Merge pull request #3208 from mirpedrol/update-subworkflows
mashehu Oct 9, 2024
3a706f0
Merge pull request #3207 from mashehu/update-modules
mashehu Oct 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -142,18 +142,18 @@ jobs:
exit 1
fi

- name: remove slashes from test name
run: |
test=$(echo ${{ matrix.test }} | sed 's/\//__/g')
echo "test=${test}" >> $GITHUB_ENV

- name: Store snapshot report
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
if: always()
with:
name: Snapshot Report ${{ matrix.test }}
name: Snapshot Report ${{ env.test }}
path: ./snapshot_report.html

- name: remove slashes from test name
run: |
test=$(echo ${{ matrix.test }} | sed 's/\//__/g')
echo "test=${test}" >> $GITHUB_ENV

- name: Upload coverage
uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4
with:
Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# nf-core/tools: Changelog

## [v3.0.1 - Titanium Tapir Patch](https://github.com/nf-core/tools/releases/tag/3.0.1) - [2024-10-09]

### Template

- Fixed an issue where the linting CI action didn't read the correct file ([#3202](https://github.com/nf-core/tools/pull/3202))
- Fixed condition for `awsfulltest` to run ([#3203](https://github.com/nf-core/tools/pull/3203))
- Fix too many empty lines added by jinja ([#3204](https://github.com/nf-core/tools/pull/3204) and [#3206](https://github.com/nf-core/tools/pull/3206))
- Fix header blocks in local subworkflow including git merge marker-like strings ([#3201](https://github.com/nf-core/tools/pull/3201))
- Update included subworkflows and modules ([#3208](https://github.com/nf-core/tools/pull/3208))

## [v3.0.0 - Titanium Tapir](https://github.com/nf-core/tools/releases/tag/3.0.0) - [2024-10-08]

**Highlights**
Expand Down
1 change: 1 addition & 0 deletions nf_core/modules/lint/main_nf.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ def check_process_section(self, lines, registry, fix_version, progress_bar):
continue
try:
container_url = "https://" + urlunparse(url) if not url.scheme == "https" else urlunparse(url)
log.debug(f"Trying to connect to URL: {container_url}")
response = requests.head(
container_url,
stream=True,
Expand Down
8 changes: 4 additions & 4 deletions nf_core/pipeline-template/.editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ indent_style = space
[*.{md,yml,yaml,html,css,scss,js}]
indent_size = 2

{% if modules %}
{% if modules -%}
# These files are edited and tested upstream in nf-core/modules
[/modules/nf-core/**]
charset = unset
Expand All @@ -25,12 +25,12 @@ end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
{% endif %}
{%- endif %}

{% if email %}
{% if email -%}
[/assets/email*]
indent_size = unset
{% endif %}
{%- endif %}

# ignore python and markdown
[*.{py,md}]
Expand Down
4 changes: 2 additions & 2 deletions nf_core/pipeline-template/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you're not used to this workflow with git, you can start with some [docs from

## Tests

{%- if test_config %}
{% if test_config -%}
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
Expand Down Expand Up @@ -139,4 +139,4 @@ To get started:
Devcontainer specs:

- [DevContainer config](.devcontainer/devcontainer.json)
{% endif %}
{%- endif %}
6 changes: 4 additions & 2 deletions nf_core/pipeline-template/.github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@ on:
jobs:
run-platform:
name: Run AWS full tests
if: github.repository == '{{ name }}' && github.event.review.state == 'approved'
# run only if the PR is approved by at least 2 reviewers and against the master branch or manually triggered
if: github.repository == '{{ name }}' && github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'master' || github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
steps:
- uses: octokit/request-action@v2.x
id: check_approvals
with:
route: GET /repos/{%- raw -%}${{ github.repository }}/pulls/${{ github.event.review.number }}/reviews
route: GET /repos/{%- raw -%}${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- id: test_variables
if: github.event_name != 'workflow_dispatch'
run: |
JSON_RESPONSE='${{ steps.check_approvals.outputs.data }}'{% endraw %}
CURRENT_APPROVALS_COUNT=$(echo $JSON_RESPONSE | jq -c '[.[] | select(.state | contains("APPROVED")) ] | length')
Expand Down
4 changes: 2 additions & 2 deletions nf_core/pipeline-template/.github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ jobs:
architecture: "x64"

- name: read .nf-core.yml
uses: pietrobolcato/action-read-yaml@1.0.0
uses: pietrobolcato/action-read-yaml@1.1.0
id: read_yml
with:
config: ${{ github.workspace }}/.nf-core.yaml
config: ${{ github.workspace }}/.nf-core.yml

- name: Install dependencies
run: |
Expand Down
2 changes: 1 addition & 1 deletion nf_core/pipeline-template/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{%- if email %}
{% if email -%}
email_template.html
{%- endif %}
{%- if adaptivecard %}
Expand Down
15 changes: 10 additions & 5 deletions nf_core/pipeline-template/docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ The directories listed below will be created in the results directory after the

The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes data using the following steps:

{% if fastqc %}- [FastQC](#fastqc) - Raw read QC{% endif %}
{% if multiqc %}- [MultiQC](#multiqc) - Aggregate report describing results and QC from the whole pipeline{% endif %}
{% if fastqc -%}

- [FastQC](#fastqc) - Raw read QC
{%- endif %}
{%- if multiqc %}
- [MultiQC](#multiqc) - Aggregate report describing results and QC from the whole pipeline
{%- endif %}
- [Pipeline information](#pipeline-information) - Report metrics generated during the workflow execution

{%- if fastqc %}
{% if fastqc -%}

### FastQC

Expand All @@ -32,7 +36,8 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d

[FastQC](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/) gives general quality metrics about your sequenced reads. It provides information about the quality score distribution across your reads, per base sequence content (%A/T/G/C), adapter contamination and overrepresented sequences. For further reading and documentation see the [FastQC help pages](http://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/).
{%- endif %}
{%- if multiqc %}

{% if multiqc -%}

### MultiQC

Expand All @@ -49,7 +54,7 @@ The pipeline is built using [Nextflow](https://www.nextflow.io/) and processes d
[MultiQC](http://multiqc.info) is a visualization tool that generates a single HTML report summarising all samples in your project. Most of the pipeline QC results are visualised in the report and further statistics are available in the report data directory.

Results generated by MultiQC collate pipeline QC from supported tools e.g. FastQC. The pipeline has special steps which also allow the software versions to be reported in the MultiQC output for future traceability. For more information about how to use MultiQC reports, see <http://multiqc.info>.
{% endif %}
{%- endif %}

### Pipeline information

Expand Down
6 changes: 3 additions & 3 deletions nf_core/pipeline-template/modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
}{% endif %}{%- if multiqc %}{% if fastqc %},{% endif %}
"multiqc": {
"branch": "master",
"git_sha": "666652151335353eef2fcd58880bcef5bc2928e1",
"git_sha": "b8d36829fa84b6e404364abff787e8b07f6d058c",
"installed_by": ["modules"]
}
{%- endif %}
Expand All @@ -23,12 +23,12 @@
"nf-core": {
"utils_nextflow_pipeline": {
"branch": "master",
"git_sha": "d20fb2a9cc3e2835e9d067d1046a63252eb17352",
"git_sha": "9d05360da397692321d377b6102d2fb22507c6ef",
"installed_by": ["subworkflows"]
},
"utils_nfcore_pipeline": {
"branch": "master",
"git_sha": "2fdce49d30c0254f76bc0f13c55c17455c1251ab",
"git_sha": "772684d9d66f37b650c8ba5146ac1ee3ecba2acb",
"installed_by": ["subworkflows"]
}{% if nf_schema %},
"utils_nfschema_plugin": {
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions nf_core/pipeline-template/modules/nf-core/multiqc/main.nf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 18 additions & 15 deletions nf_core/pipeline-template/nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ params {
// Input options
input = null

{%- if igenomes %}
{% if igenomes -%}
// References
genome = null
igenomes_base = 's3://ngi-igenomes/igenomes/'
igenomes_ignore = false
{%- endif %}

{%- if multiqc %}
{% if multiqc -%}
// MultiQC options
multiqc_config = null
multiqc_title = null
Expand All @@ -45,7 +45,7 @@ params {
version = false
{% if test_config %}pipelines_testdata_base_path = 'https://raw.githubusercontent.com/nf-core/test-datasets/'{% endif %}

{%- if nf_core_configs %}
{% if nf_core_configs -%}
// Config options
config_profile_name = null
config_profile_description = null
Expand All @@ -56,15 +56,17 @@ params {
config_profile_url = null
{%- endif %}

{%- if nf_schema %}
{% if nf_schema -%}
// Schema validation default options
validate_params = true
{% endif %}
{%- endif %}
}
{% if modules %}

{% if modules -%}
// Load base.config by default for all pipelines
includeConfig 'conf/base.config'
{%- else %}

process {
// TODO nf-core: Check the defaults for all processes
cpus = { 1 * task.attempt }
Expand All @@ -75,7 +77,7 @@ process {
maxRetries = 1
maxErrors = '-1'
}
{% endif %}
{%- endif %}

profiles {
debug {
Expand Down Expand Up @@ -171,14 +173,14 @@ profiles {
wave.freeze = true
wave.strategy = 'conda,container'
}
{%- if gitpod %}
{% if gitpod -%}
gitpod {
executor.name = 'local'
executor.cpus = 4
executor.memory = 8.GB
}
{%- endif %}
{%- if test_config %}
{% if test_config -%}
test { includeConfig 'conf/test.config' }
test_full { includeConfig 'conf/test_full.config' }
{%- endif %}
Expand All @@ -191,7 +193,7 @@ includeConfig !System.getenv('NXF_OFFLINE') && params.custom_config_base ? "${pa
// Load {{ name }} custom profiles from different institutions.
// TODO nf-core: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
// includeConfig !System.getenv('NXF_OFFLINE') && params.custom_config_base ? "${params.custom_config_base}/pipeline/{{ short_name }}.config" : "/dev/null"
{% endif -%}
{%- endif %}

// Set default registry for Apptainer, Docker, Podman, Charliecloud and Singularity independent of -profile
// Will not be used unless Apptainer / Docker / Podman / Charliecloud / Singularity are enabled
Expand All @@ -205,7 +207,7 @@ charliecloud.registry = 'quay.io'
{% if igenomes -%}
// Load igenomes.config if required
includeConfig !params.igenomes_ignore ? 'conf/igenomes.config' : 'conf/igenomes_ignored.config'
{% endif -%}
{%- endif %}

// Export these variables to prevent local Python/R libraries from conflicting with those in the container
// The JULIA depot path has been adjusted to a fixed path `/usr/local/share/julia` that needs to be used for packages in the container.
Expand Down Expand Up @@ -273,7 +275,7 @@ validation {
command = "nextflow run $manifest.name -profile <docker/singularity/.../institute> --input samplesheet.csv --outdir <OUTDIR>"
fullParameter = "help_full"
showHiddenParameter = "show_hidden"
{%- if is_nfcore %}
{% if is_nfcore -%}
beforeText = """
-\033[2m----------------------------------------------------\033[0m-
\033[0;32m,--.\033[0;30m/\033[0;32m,-.\033[0m
Expand All @@ -297,8 +299,9 @@ validation {
afterText = validation.help.afterText
}{% endif %}
}
{% endif -%}
{%- if modules %}
{%- endif %}

{% if modules -%}
// Load modules.config for DSL2 module specific options
includeConfig 'conf/modules.config'
{% endif %}
{%- endif %}
Loading
Loading