Skip to content

docs: DIA-NN container licensing + local build (add 2.5.0); open 2.2.0dev - #97

Merged
ypriverol merged 3 commits into
devfrom
docs/diann-container-licensing
Jun 2, 2026
Merged

ypriverol merged 3 commits into
devfrom
docs/diann-container-licensing

Conversation

@ypriverol

@ypriverol ypriverol commented May 30, 2026 •

Copy link
Copy Markdown
Contributor

Targets dev.

Docs (container licensing)

The Supported DIA-NN Versions table and docs/usage.md implied the ghcr.io/bigbio/diann:* images are directly pullable. They are not public — DIA-NN's license only permits redistribution of 1.8.1 (the default, from BioContainers). This clarifies:

  • Build 1.9+ locally from quantms-containers and tag ghcr.io/bigbio/diann:<version> so -profile diann_v<version> resolves it automatically.
  • Added the missing 2.5.0 row to the README support table (already present in docs/usage.md and conf/diann_versions/v2_5_0.config).

Version

  • Bump pipeline version 2.1.0 → 2.2.0dev (nextflow.config manifest + .nf-core.yml), open a 2.2.0dev CHANGELOG section.

Docs + version metadata only; no code/config logic changes.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@github-actions

Copy link
Copy Markdown

This PR is against the main branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @ypriverol,

It looks like this pull-request has been made against the bigbio/quantmsdiann main branch.
The main branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to main are only allowed if they come from the bigbio/quantmsdiann 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.

Thanks again for your contribution!

@coderabbitai

coderabbitai Bot commented May 30, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3145315a-dae8-4c0e-b568-90ee20010192

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR updates documentation to reflect DIA-NN 2.5.0 support and adds licensing constraints. The README adds a new version table entry and an IMPORTANT notice explaining that only version 1.8.1 is publicly redistributable; versions 1.9+ require local container builds from quantms-containers and must be tagged as ghcr.io/bigbio/diann:<version>. Matching guidance is added to docs/usage.md.

Changes

DIA-NN versioning and licensing documentation

Layer / File(s) Summary
Version support and licensing documentation
README.md, docs/usage.md
README.md adds DIA-NN 2.5.0 to the supported versions table and introduces an IMPORTANT licensing notice explaining that only version 1.8.1 is publicly redistributable; versions 1.9+ must be built locally from quantms-containers and tagged as ghcr.io/bigbio/diann:<version> to match pipeline profiles. docs/usage.md adds the same licensing constraint and build/tagging instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • bigbio/quantmsdiann#61: Both PRs update docs/usage.md with DIA-NN container redistribution and version-handling guidance (1.8.1 vs 2.x, custom container binding).

Poem

🐰 A tale of versions, old and new,
2.5.0 joins the trusty crew,
But licensing says "one's for free,"
Build the rest, locally—you see?
With proper tags and careful care,
Your pipelines flow beyond compare! 🎀

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: documentation clarifications about DIA-NN container licensing and local build instructions, plus addition of version 2.5.0.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/diann-container-licensing

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions

github-actions Bot commented May 30, 2026 •

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 42a4f27

+| ✅ 108 tests passed       |+
#| ❔  18 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗   4 tests had warnings |!
Details

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • files_exist - File not found: .github/workflows/awstest.yml
  • files_exist - File not found: .github/workflows/awsfulltest.yml

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-06-02 06:50:31

Only DIA-NN 1.8.1 is redistributable (public BioContainers, the default).
Releases 1.9+ cannot be redistributed under the DIA-NN license, so the
ghcr.io/bigbio/diann:* images are not public and must be built locally from
the quantms-containers recipes, tagged ghcr.io/bigbio/diann:<version> so the
matching -profile diann_v<version> resolves them. Add the missing 2.5.0 row to
the README support table and a matching note in docs/usage.md.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/usage.md (1)

207-214: ⚡ Quick win

Consider expanding the licensing notice for consistency.

The README.md version of this notice (lines 49-68) provides additional helpful details:

  • Singularity build alternative
  • More emphatic tagging requirement ("MUST be tagged")
  • Explicitly states images are "not public"

While the concise version here is acceptable, matching the README's detail level would help users who land directly on the usage doc.

📝 Proposed expansion to match README detail
 > [!IMPORTANT]
-> DIA-NN's license only permits public redistribution of **version 1.8.1**, which
-> is pulled automatically from BioContainers (`docker.io/biocontainers/diann:v1.8.1_cv1`).
-> Containers for **1.9 and later are not public**: build them locally from the
+> **DIA-NN licensing.** Only **DIA-NN 1.8.1** is redistributable and is pulled
+> automatically from the public BioContainers image
+> (`docker.io/biocontainers/diann:v1.8.1_cv1`), so the default profile works out
+> of the box. The DIA-NN license does **not** permit redistribution of releases
+> from 1.9 onward, so the `ghcr.io/bigbio/diann:*` images above are **not
+> public** — with a valid DIA-NN download you build them locally from the
 > [`quantms-containers`](https://github.com/bigbio/quantms-containers) recipes and
-> tag the image `ghcr.io/bigbio/diann:<version>` so the matching
-> `-profile diann_v<version>` resolves it, e.g.
-> `cd quantms-containers/diann-2.5.0 && docker build -t ghcr.io/bigbio/diann:2.5.0 .`
+> tag the image `ghcr.io/bigbio/diann:<version>`:
+>
+> ```bash
+> git clone https://github.com/bigbio/quantms-containers
+> cd quantms-containers/diann-2.5.0
+> docker build -t ghcr.io/bigbio/diann:2.5.0 .          # Docker
+> # or, for Singularity/Apptainer:
+> singularity build diann-2.5.0.sif docker-daemon://ghcr.io/bigbio/diann:2.5.0
+> ```
+>
+> The image **must** be tagged `ghcr.io/bigbio/diann:<version>` (matching the
+> `Container` column) for the matching `-profile diann_v<version>` to pick it up
+> automatically.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/usage.md` around lines 207 - 214, Expand the existing "[!IMPORTANT]"
DIA-NN license notice to match the README's detail: explicitly state that images
for versions >=1.9 are "not public", require the image "MUST" be tagged as
ghcr.io/bigbio/diann:<version>, and add the build examples for both Docker and
Singularity/Apptainer (clone quantms-containers, docker build and singularity
build commands) so the usage.md "[!IMPORTANT]" block contains the same
Singularity alternative, stronger tagging language, and example commands as the
README version.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/usage.md`:
- Around line 207-214: Expand the existing "[!IMPORTANT]" DIA-NN license notice
to match the README's detail: explicitly state that images for versions >=1.9
are "not public", require the image "MUST" be tagged as
ghcr.io/bigbio/diann:<version>, and add the build examples for both Docker and
Singularity/Apptainer (clone quantms-containers, docker build and singularity
build commands) so the usage.md "[!IMPORTANT]" block contains the same
Singularity alternative, stronger tagging language, and example commands as the
README version.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0e4ffc92-76a7-43b0-a0c2-40cab6807768

📥 Commits

Reviewing files that changed from the base of the PR and between 9af0b39 and e9e68b5.

📒 Files selected for processing (2)
  • README.md
  • docs/usage.md

Open the 2.2.0 development cycle (manifest.version + .nf-core.yml), add a
2.2.0dev CHANGELOG section.
@ypriverol
ypriverol force-pushed the docs/diann-container-licensing branch from e9e68b5 to 0ce090d Compare May 30, 2026 08:15
@ypriverol
ypriverol changed the base branch from main to dev May 30, 2026 08:15
@ypriverol ypriverol changed the title docs: clarify DIA-NN container licensing + local build; add 2.5.0 row docs: DIA-NN container licensing + local build (add 2.5.0); open 2.2.0dev May 30, 2026
The test_dia_dotd database URL pointed at databases/PXD065380.fasta
(404); the FASTA actually lives at databases/PXD065380/PXD065380.fasta
in quantms-test-datasets. Fixes the download failure breaking the
test_dia_dotd CI jobs. Also re-triggers CI now that this PR targets
dev (the prior --release lint / branch-protection failures were from
when it briefly targeted main).
@ypriverol
ypriverol merged commit 912c1c8 into dev Jun 2, 2026
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant