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

Release version 1.1.3 #237

Merged
merged 77 commits into from
Feb 9, 2025
Merged
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
2ffef33
bump to 1.2.0dev
subwaystation Mar 25, 2024
6719020
Merge pull request #195 from subwaystation/dev
subwaystation Mar 25, 2024
1708db9
update workflow svg
subwaystation Apr 30, 2024
411a5dc
finished makeup2
subwaystation May 1, 2024
1aed918
Merge pull request #199 from nf-core/workflow_svg
subwaystation May 1, 2024
cdc1494
Template update for nf-core/tools version 2.14.0
nf-core-bot May 8, 2024
1e52981
Template update for nf-core/tools version 2.14.1
nf-core-bot May 9, 2024
d4a3def
Template update for nf-core/tools version 3.0.0
nf-core-bot Oct 8, 2024
f21fb92
Template update for nf-core/tools version 3.0.1
nf-core-bot Oct 9, 2024
e7671c6
Template update for nf-core/tools version 3.0.2
nf-core-bot Oct 11, 2024
62f8366
Template update for nf-core/tools version 3.1.0
nf-core-bot Dec 12, 2024
782e1c6
Template update for nf-core/tools version 3.1.1
nf-core-bot Dec 20, 2024
67b3acf
Merged changes from nf-core template
heuermh Jan 8, 2025
a6622ad
Fix up invalid input values
heuermh Jan 8, 2025
407820f
Fix up incorrectly typed input values
heuermh Jan 8, 2025
3c96fea
Add exceptions to files_exist lint check
heuermh Jan 8, 2025
62bf0eb
Removing unnecessary fastqc test files
heuermh Jan 8, 2025
3ffab69
Remove samplesheet output channel from PIPELINE_INITIALIZATION
heuermh Jan 8, 2025
6d2b02f
Update to nf-core/setup-nextflow@2 in custom CI jobs
heuermh Jan 8, 2025
57aee62
Add missing ch_versions channel
heuermh Jan 8, 2025
973bbe9
Fix up pangenome workflow
heuermh Jan 8, 2025
a67f17e
Attempt to fix lint errors
heuermh Jan 8, 2025
f038844
Set validation lenientMode to true
heuermh Jan 13, 2025
0947d1f
Address review comments
heuermh Jan 15, 2025
5a5941c
Merge pull request #213 from heuermh/merging-template-updates
heuermh Jan 15, 2025
784a9af
Update nf-core/smoothxg module to version 0.8.0
heuermh Jan 15, 2025
10beeb4
Merge pull request #216 from heuermh/smoothxg-0.8.0
subwaystation Jan 16, 2025
1d128e7
make n_haplotypes null
subwaystation Jan 17, 2025
b1bca81
Merge pull request #220 from nf-core/i218
heuermh Jan 17, 2025
8fd5000
Refactor authors to list of contributors
heuermh Jan 17, 2025
620d289
Fix lint errors
heuermh Jan 17, 2025
ec89f70
Update affiliations
heuermh Jan 17, 2025
fd3fe4b
Commit suggested change
heuermh Jan 18, 2025
e93a3bd
Fix typo
heuermh Jan 18, 2025
0649f70
Merge branch 'contributors' of https://github.com/heuermh/nf-core-pan…
heuermh Jan 18, 2025
c467403
update local module multiqc_community to v1.25
subwaystation Jan 20, 2025
013ed8b
address linter issues
subwaystation Jan 20, 2025
c49fc01
Template update for nf-core/tools version 3.1.2
nf-core-bot Jan 20, 2025
2c5df9b
update multiqc to v1.26 to fix i224
subwaystation Jan 22, 2025
081a6e1
Add docs/images to files_unchanged
heuermh Jan 22, 2025
32ce9ce
Apply patch from https://github.com/nf-core/tools/pull/3416
heuermh Jan 22, 2025
0a8501e
Merge pull request #229 from heuermh/lint-i224
subwaystation Jan 22, 2025
aba25bf
Merge pull request #227 from nf-core/i224
heuermh Jan 22, 2025
1b1a646
Fixed merge conflicts
heuermh Jan 22, 2025
82e3cdf
Fix lint errors
heuermh Jan 22, 2025
9fbfa41
Fix prettier errors
heuermh Jan 22, 2025
de29a8a
Fix bibliography error
heuermh Jan 22, 2025
809e81d
lost & found
subwaystation Jan 23, 2025
be2eaff
Merge pull request #232 from nf-core/hotfix_i224
subwaystation Jan 23, 2025
a2675ca
Merge pull request #231 from heuermh/merging-template-updates
subwaystation Jan 23, 2025
6087a32
Update nf-core odgi modules to version 0.9.0
heuermh Jan 23, 2025
d0b1e1e
Fix prettier error
heuermh Jan 23, 2025
1471964
Merge branch 'multiqc_community_1.25' of https://github.com/nf-core/p…
heuermh Jan 23, 2025
2e9a283
update pggb docker to contain vg v1.62
subwaystation Jan 27, 2025
abe9a5f
Template update for nf-core/tools version 3.2.0
nf-core-bot Jan 27, 2025
c8a7f9a
Apply suggestions from code review
heuermh Jan 27, 2025
f0d2287
Apply suggestions from code review
heuermh Jan 27, 2025
d5156bd
Merge pull request #234 from nf-core/vg_1.62
heuermh Jan 27, 2025
c9a6ec3
Attempt to fix prettier lint error
heuermh Jan 27, 2025
312e13c
Attempt to fix prettier lint error
heuermh Jan 27, 2025
f5fb5a8
Merge pull request #222 from heuermh/contributors
heuermh Jan 27, 2025
42671dd
Merge branch 'dev' of https://github.com/nf-core/pangenome into odgi-…
heuermh Jan 27, 2025
76654ad
Update multiqc_community to version 1.26
heuermh Jan 27, 2025
08e0e73
fix odgi stats table not appearing
subwaystation Jan 28, 2025
d22b333
Merge pull request #233 from heuermh/odgi-0.9.0
subwaystation Jan 28, 2025
ff2e8c1
resolve merge conflicts, local multiqc to v1.27
subwaystation Jan 28, 2025
cdb5f70
Merge pull request #235 from nf-core/nf-core-template-merge-3.2.0
heuermh Jan 28, 2025
38c1d9a
prepare 1.1.3 release
subwaystation Jan 30, 2025
5558242
commit hidden file
subwaystation Jan 30, 2025
6e611e8
prettier
subwaystation Jan 30, 2025
7c435e5
Merge pull request #236 from subwaystation/dev
heuermh Jan 30, 2025
63b639b
Resolve merge conflicts
heuermh Jan 30, 2025
d292756
Merge pull request #238 from heuermh/dev
heuermh Jan 30, 2025
ae0ff02
Fix release lint error
heuermh Jan 30, 2025
40c25e8
Retrigger CI checks
heuermh Jan 30, 2025
1fcf24e
Merge pull request #239 from heuermh/1.1.3-release-lint
subwaystation Jan 31, 2025
f2b63fe
fix pipeline information header in output.md
subwaystation Feb 3, 2025
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
10 changes: 5 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -28,10 +28,10 @@ indent_style = unset
[/assets/email*]
indent_size = unset

# ignore Readme
[README.md]
indent_style = unset

# ignore python
# ignore python and markdown
[*.{py,md}]
indent_style = unset

# ignore ro-crate metadata files
[**/ro-crate-metadata.json]
insert_final_newline = unset
24 changes: 12 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nf-core/pangenome: Contributing Guidelines
# `nf-core/pangenome`: Contributing Guidelines

Hi there!
Many thanks for taking an interest in improving nf-core/pangenome.
@@ -19,7 +19,7 @@ If you'd like to write some code for nf-core/pangenome, the standard workflow is
1. Check that there isn't already an issue about your idea in the [nf-core/pangenome issues](https://github.com/nf-core/pangenome/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/pangenome repository](https://github.com/nf-core/pangenome) 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/).
@@ -40,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.

@@ -55,27 +55,27 @@ These tests are run both with the latest available version of `Nextflow` and als

:warning: Only in the unlikely and regretful event of a release happening with a bug.

- On your own fork, make a new branch `patch` based on `upstream/master`.
- On your own fork, make a new branch `patch` based on `upstream/main` or `upstream/master`.
- Fix the bug, and bump version (X.Y.Z+1).
- A PR should be made on `master` from patch to directly this particular bug.
- Open a pull-request from `patch` to `main`/`master` with the changes.

## Getting help

For further information/help, please consult the [nf-core/pangenome documentation](https://nf-co.re/pangenome/usage) and don't hesitate to get in touch on the nf-core Slack [#pangenome](https://nfcore.slack.com/channels/pangenome) channel ([join our Slack here](https://nf-co.re/join/slack)).

## Pipeline contribution conventions

To make the nf-core/pangenome code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.
To make the `nf-core/pangenome` code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.

### Adding a new step

If you wish to contribute a new step, please use the following coding standards:

1. Define the corresponding input channel into your new process from the expected previous process channel
1. Define the corresponding input channel into your new process from the expected previous process channel.
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`.
@@ -84,13 +84,13 @@ If you wish to contribute a new step, please use the following coding standards:

### Default values

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

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.cpus}` and `${task.memory}` variables in the `script:` block.

@@ -103,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

1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -9,7 +9,6 @@ body:

- [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
- [nf-core/pangenome pipeline documentation](https://nf-co.re/pangenome/usage)

- type: textarea
id: description
attributes:
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -17,8 +17,8 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/pang
- [ ] 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/pangenome/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/pangenome _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Ensure the test suite passes (`nf-test test main.nf.test -profile test,docker`).
- [ ] 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.
- [ ] Output Documentation in `docs/output.md` is updated.
48 changes: 39 additions & 9 deletions .github/workflows/awsfulltest.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,49 @@
name: nf-core AWS full size tests
# This workflow is triggered on published releases.
# This workflow is triggered on PRs opened against the main/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:
- main
- master
workflow_dispatch:
pull_request_review:
types: [submitted]

jobs:
run-tower:
run-platform:
name: Run AWS full tests
if: github.repository == 'nf-core/pangenome'
# 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/pangenome' && github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'master' || github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
steps:
- name: Launch workflow via tower
- name: Get PR reviews
uses: octokit/request-action@v2.x
if: github.event_name != 'workflow_dispatch'
id: check_approvals
continue-on-error: true
with:
route: GET /repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews?per_page=100
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Check for approvals
if: ${{ failure() && github.event_name != 'workflow_dispatch' }}
run: |
echo "No review approvals found. At least 2 approvals are required to run this action automatically."
exit 1

- name: Check for enough approvals (>=2)
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 }}
@@ -30,7 +60,7 @@ jobs:

- 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
12 changes: 6 additions & 6 deletions .github/workflows/awstest.yml
Original file line number Diff line number Diff line change
@@ -5,13 +5,13 @@ name: nf-core AWS test
on:
workflow_dispatch:
jobs:
run-tower:
run-platform:
name: Run AWS tests
if: github.repository == 'nf-core/pangenome'
runs-on: ubuntu-latest
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 }}
@@ -27,7 +27,7 @@ jobs:

- 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
18 changes: 10 additions & 8 deletions .github/workflows/branch.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
name: nf-core branch protection
# This workflow is triggered on PRs to master branch on the repository
# It fails when someone tries to make a PR against the nf-core `master` branch instead of `dev`
# This workflow is triggered on PRs to `main`/`master` branch on the repository
# It fails when someone tries to make a PR against the nf-core `main`/`master` branch instead of `dev`
on:
pull_request_target:
branches: [master]
branches:
- main
- master

jobs:
test:
runs-on: ubuntu-latest
steps:
# PRs to the nf-core repo master branch are only ok if coming from the nf-core repo `dev` or any `patch` branches
# PRs to the nf-core repo main/master branch are only ok if coming from the nf-core repo `dev` or any `patch` branches
- name: Check PRs
if: github.repository == 'nf-core/pangenome'
run: |
@@ -22,7 +24,7 @@ jobs:
uses: mshick/add-pr-comment@b8f338c590a895d50bcbfa6c5859251edc8952fc # v2
with:
message: |
## This PR is against the `master` branch :x:
## This PR is against the `${{github.event.pull_request.base.ref}}` branch :x:

* Do not close this PR
* Click _Edit_ and change the `base` to `dev`
@@ -32,9 +34,9 @@ jobs:

Hi @${{ github.event.pull_request.user.login }},

It looks like this pull-request is has been made against the [${{github.event.pull_request.head.repo.full_name }}](https://github.com/${{github.event.pull_request.head.repo.full_name }}) `master` branch.
The `master` branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to `master` are only allowed if they come from the [${{github.event.pull_request.head.repo.full_name }}](https://github.com/${{github.event.pull_request.head.repo.full_name }}) `dev` branch.
It looks like this pull-request is has been made against the [${{github.event.pull_request.head.repo.full_name }}](https://github.com/${{github.event.pull_request.head.repo.full_name }}) ${{github.event.pull_request.base.ref}} branch.
The ${{github.event.pull_request.base.ref}} branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to ${{github.event.pull_request.base.ref}} are only allowed if they come from the [${{github.event.pull_request.head.repo.full_name }}](https://github.com/${{github.event.pull_request.head.repo.full_name }}) `dev` branch.

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.
Note that even after this, the test will continue to show as failing until you push a new commit.
Loading