Repository navigation
docs: DIA-NN container licensing + local build (add 2.5.0); open 2.2.0dev - #97
Conversation
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
This PR is against the
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis 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 ChangesDIA-NN versioning and licensing documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
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.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/usage.md (1)
207-214: ⚡ Quick winConsider 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.
Open the 2.2.0 development cycle (manifest.version + .nf-core.yml), add a 2.2.0dev CHANGELOG section.
e9e68b5 to
0ce090d
Compare
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).
Targets
dev.Docs (container licensing)
The
Supported DIA-NN Versionstable anddocs/usage.mdimplied theghcr.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:quantms-containersand tagghcr.io/bigbio/diann:<version>so-profile diann_v<version>resolves it automatically.conf/diann_versions/v2_5_0.config).Version
2.1.0→2.2.0dev(nextflow.configmanifest +.nf-core.yml), open a2.2.0devCHANGELOG section.Docs + version metadata only; no code/config logic changes.