diff --git a/CHANGELOG.md b/CHANGELOG.md index b3e8e402..ef0b53b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ Each release's notes. From 1.0.0 on, a major or minor release has hand-written n ## Unreleased +- Renovate holds ExpansionHunter at its pinned 5.0.0 image, the last Apache-2.0 release. Every bump, including a Bioconda rebuild, needs a licence review by hand. Upstream's default branch uses PolyForm Strict 1.0.0. - ROH summaries now divide F_ROH by the GRCh38 length outside the bands of the assessed autosomes. Per-site rows identify those chromosomes, including chromosomes with no ROH. A new `roh.data.scope` records the chromosomes, denominator and scope source. Relationship labels and UPD flags require sites on all 22 autosomes and the full unmasked autosome length. Segment-only files use their observed chromosomes as an unverified lower bound and get neither label. Empty input has null F_ROH. Segment counts and the step 11 summary table keep their format. - A one-chromosome ROH flag now names regions and citations without syndrome names. Its note includes deletion, acquired loss of heterozygosity and shared ancestry as alternatives. The maternal and paternal JSON keys remain as `"-"` for reader compatibility. The attributed `assets/imprinted_regions.tsv` is embedded at build time, replacing the duplicated Rust table. The container builder mounts it, and the source stamp includes its blob hash, so a table edit makes an old binary stale. The stamp format and `tree-hash` command name stay the same. Every listed chromosome uses the same lookup, including chr11 and chr15. A region hint does not establish overlap with its imprinted locus or parental origin. Broad cytoband names remain reference labels, not diagnostic intervals. - The ROH collector now streams per-site rows instead of keeping the whole file in memory. On 1.1 million synthetic site rows, peak RSS fell from 65.7-67.0 MB to 3.0-3.5 MB. CPU time stayed near 0.2 seconds. Under shared host load, wall time ranged from 1.40-21.46 seconds before and 7.89-38.16 seconds after; these timings do not establish a speedup. diff --git a/docs/updating.md b/docs/updating.md index 17f2561f..73fb46ac 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -63,6 +63,7 @@ Each hold is a rule in `renovate.json` with its reason in the rule's `descriptio | Pin | Rule | Why | When it ends | |---|---|---|---| +| ExpansionHunter 5.0.0 | disabled, including Bioconda rebuilds | [5.0.0 is Apache-2.0](https://github.com/Illumina/ExpansionHunter/blob/v5.0.0/LICENSE.txt). [Upstream's default branch uses PolyForm Strict 1.0.0](https://github.com/Illumina/ExpansionHunter/blob/master/LICENSE.txt) | read the proposed tag's licence and the image's conda-meta licence before changing the hold. A PolyForm Strict version must become opt-in with a notice, like Cyrius | | pypgx 0.26.0 | only `0.26.0--` tags | 0.27.0 pulled pandas 3.0 and broke every gene while its smoke test still passed | upstream releases the pandas fix and a pypgx-bundle tag of the same version exists; move `PYPGX_BUNDLE_VERSION` with it | | plink2 2.00a5.10 | disabled | the only versioned tag `pgscatalog/plink2` ships, and the build pgsc_calc uses | a newer tag from that publisher | | Manta, Strelka2, duphold, Octopus, GRIDSS | disabled | legacy: archived or quiet upstream | bump by hand after a run on the fixture | @@ -74,6 +75,7 @@ Each hold is a rule in `renovate.json` with its reason in the rule's `descriptio ## What to check by hand +- **Image licences**: before any image bump, read the upstream licence at the proposed tag. For a Bioconda image, also check the licence fields of every package in its conda-meta files. A version or build number alone does not prove the licence. Keep ExpansionHunter held until that review is complete. - **PharmCAT**: diff the diplotype table on the HG002 fixture between the old and the new image, and run the CPIC parser tests on a `report.json` from the new version. - **VEP major**: move `VEP_CACHE_RELEASE` to the new major and `GENCODE_RELEASE` (`scripts/lib/common.sh`) to the new major minus 66 in the same PR, download the new cache (about 26 GB) and rerun step 13. CI cannot run the offline cache. - **PCGR/CPSR**: move `PCGR_DATA_BUNDLE` and `PCGR_VEP_CACHE_RELEASE` with the image, and rerun step 17 on a sample with an earlier result. CI does not run CPSR on a sample. The image test checks that `cpsr --help` still lists every flag step 17 passes, that `cpsr --version` names the release line of the image tag and the `pcgrr` R package its full release, and runs the bundled VEP with `--database` on 50 variants. diff --git a/docs/versions.md b/docs/versions.md index 539d5a4a..baa298b2 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -42,7 +42,7 @@ This page is generated by `scripts/ci/gen-versions-doc.sh` from `versions.env` a | Specialized analysis | hipstr | `HIPSTR_IMAGE` | `quay.io/biocontainers/hipstr` | `0.7--hcf09f9e_1` | optional: step 45 (opt-in, Y-STR repeat counts of male samples) | | Specialized analysis | t1k | `T1K_IMAGE` | `quay.io/biocontainers/t1k` | `1.0.10--h5814d7d_0` | | | Specialized analysis | optitype | `OPTITYPE_IMAGE` | `quay.io/biocontainers/optitype` | `1.5.0--pyhdfd78af_1` | optional: step 08 with HLA_QC=true (opt-in second HLA caller, class I) | -| Specialized analysis | expansionhunter | `EXPANSIONHUNTER_IMAGE` | `quay.io/biocontainers/expansionhunter` | `5.0.0--hc26b3af_5` | | +| Specialized analysis | expansionhunter | `EXPANSIONHUNTER_IMAGE` | `quay.io/biocontainers/expansionhunter` | `5.0.0--hc26b3af_5` | hold: last Apache-2.0 release; upstream now PolyForm Strict; Renovate disabled, review the licence before any bump | | Specialized analysis | goleft | `GOLEFT_IMAGE` | `quay.io/biocontainers/goleft` | `0.2.6--he881be0_1` | | | Specialized analysis | mosdepth | `MOSDEPTH_IMAGE` | `quay.io/biocontainers/mosdepth` | `0.3.14--h87be163_2` | | | Specialized analysis | parascopy | `PARASCOPY_IMAGE` | `quay.io/biocontainers/parascopy` | `1.19.0--py311h98bf483_0` | optional: step 35 (opt-in, SMN1/SMN2 copy number) | diff --git a/renovate.json b/renovate.json index 14f063c4..426ca025 100644 --- a/renovate.json +++ b/renovate.json @@ -170,6 +170,12 @@ ], "packageRules": [ + { + "description": "Hold: ExpansionHunter 5.0.0 is the last Apache-2.0 release. Upstream's default branch uses PolyForm Strict 1.0.0. All updates, including Bioconda rebuilds, need a licence review by hand before this hold is changed (docs/updating.md).", + "matchDatasources": ["docker"], + "matchPackageNames": ["quay.io/biocontainers/expansionhunter"], + "enabled": false + }, { "description": [ "Biocontainer tags are --_. Docker versioning reads the part after '--' as a suffix that must stay the same, and the hash changes between versions, so most of these pins would never see a newer tag.", diff --git a/versions.env b/versions.env index 30402413..2900e700 100644 --- a/versions.env +++ b/versions.env @@ -74,7 +74,7 @@ YLEAF_IMAGE="quay.io/biocontainers/yleaf:4.1.7--pyhdfd78af_0" # optional: step HIPSTR_IMAGE="quay.io/biocontainers/hipstr:0.7--hcf09f9e_1" # optional: step 45 (opt-in, Y-STR repeat counts of male samples) T1K_IMAGE="quay.io/biocontainers/t1k:1.0.10--h5814d7d_0" OPTITYPE_IMAGE="quay.io/biocontainers/optitype:1.5.0--pyhdfd78af_1" # optional: step 08 with HLA_QC=true (opt-in second HLA caller, class I) -EXPANSIONHUNTER_IMAGE="quay.io/biocontainers/expansionhunter:5.0.0--hc26b3af_5" +EXPANSIONHUNTER_IMAGE="quay.io/biocontainers/expansionhunter:5.0.0--hc26b3af_5" # hold: last Apache-2.0 release; upstream now PolyForm Strict; Renovate disabled, review the licence before any bump GOLEFT_IMAGE="quay.io/biocontainers/goleft:0.2.6--he881be0_1" MOSDEPTH_IMAGE="quay.io/biocontainers/mosdepth:0.3.14--h87be163_2" PARASCOPY_IMAGE="quay.io/biocontainers/parascopy:1.19.0--py311h98bf483_0" # optional: step 35 (opt-in, SMN1/SMN2 copy number)