Skip to content

feat: Release v19.0.0#1666

Open
fevac wants to merge 19 commits intomasterfrom
release_v19.0.0
Open

feat: Release v19.0.0#1666
fevac wants to merge 19 commits intomasterfrom
release_v19.0.0

Conversation

@fevac
Copy link
Copy Markdown
Collaborator

@fevac fevac commented Mar 26, 2026

Release branch for balsamic v19.0.0

Added:
^^^^^^

Changed:
^^^^^^^^

Removed:
^^^^^^^^

Fixed:
^^^^^^

STATUS sheet: https://docs.google.com/spreadsheets/d/10dpLjxxU6xsDbNp6grUzhvPzo6Ubp9yxGDtvT7UDSrA/edit?gid=0#gid=0

Pre-Validation Checklist

Before proceeding with the validation process, ensure that the following tasks have been completed:

  • Install Balsamic in stage and production environments in hasta and build its cache.

    • BALSAMIC was installed on stage after making the BALSAMIC release_v19.0.0 branch, from the instructions given above:
    1. sudo <...>
    2. Activate stage and conda environments.
    3. pip uninstall balsamic
    4. pip install --no-cache-dir -U git+https://github.com/Clinical-Genomics/BALSAMIC@release_v19.0.0
    5. balsamic init --cache-version 19.0.0 --account development -r -g hg19 --out-dir /home/proj/stage/cancer/balsamic_cache --qos high

    NOTE: balsamic init failed in the rules that fetch the containers and the clinvar preprocessing rule. Since there is no changes in containers, images have been copied over from the previous release. Clinvar files have not been updated and we have copied the ones from the previous release. In particular these two files have been copied: /home/proj/production/cancer/balsamic_cache/18.0.1/hg19/variants/clinvar_processed.vcf.gz and /home/proj/production/cancer/balsamic_cache/18.0.1/hg19/variants/clinvar_processed.vcf.gz.tbi

    1. Export most recent loqusDB databases by following: https://atlas.scilifelab.se/infrastructure/bioinformatic_pipelines/BALSAMIC/export_loqusdb_variants/ --> Same databases as for v18.0.1 will be used.
  • Confirm the availability of necessary resources, such as test cases. (Made script to verify this automatically: /home/proj/stage/cancer/validation/scripts/verify_presence_of_test_samples.sh)

  • Review the changelog and ensure all changes and updates are documented:

    Document Sections to Be Updated Pull Request
    Balsamic Documentation Already updated in development PRs NA
    Atlas Documentation A lot of sections updated! https://github.com/Clinical-Genomics/atlas/pull/4538/
  • Set up the stage environment with the necessary software and configurations:

    Software Current Version Pull Request with the Required Updates
    CG Balsamic v19 cg#4915
    Servers https://github.com/Clinical-Genomics/servers/pull/1818
    Hermes Balsamic 19 changes hermes#161

Workflow integrity results

Workflow Integrity Verification Cases

More details here:

CaseID AnalysisType T/TN SequencingType ExpectedQC Status(Pass/Fail)
civilsole balsamic tumor-only WGS Fail (PCT_60X=0.004532) PASS
fleetjay balsamic tumor-normal WGS QC metric PCT_60X: 0.006589 validation has failed PASS
setamoeba balsamic tumor-only TGA Pass PASS
unitedbeagle balsamic tumor-normal TGA Pass PASS
uphippo balsamic-umi tumor-only TGA Fail (GC dropout=1.650392) , QC metric PCT_TARGET_BASES_1000X: 0.915272 PASS
equalbug balsamic-umi tumor-normal TGA Fail (GC_DROPOUT=1.087173 and RELATEDNESS=-0.524) PASS

Release specific integration verifications:

[ADD]

Verification summary:

  • This section has been verified successfully

Storage, Delivery and Upload Integrity Verifications

Processes Affected in current version Affected workflows
New files to be stored Yes CNV.interactive_report.html
New files to be delivered Yes CNV.interactive_report.html
New files to be uploaded to Scout Yes CNV.interactive_report.html
New files to be uploaded to LoqusDB No
Changes to Housekeeper IDs Yes CNV.report.pdf (scout tag excluded from WES and TGS); added CNV.interactive_report.html for WES and TGS
Changes to Scout upload Yes CNV.report.pdf replaced with CNV.interactive_report.html for WES and TGS
Changes to delivery report Yes AT dropout included. AT and GC dropout for WGS analyses replaced with Hsmetrics
AnalysisType T/TN Storage status Delivery status Upload status
balsamic wgs tumor-only pass
balsamic wgs tumor-normal pass
balsamic tumor-only pass
balsamic tumor-normal pass
balsamic-umi tumor-only pass
balsamic-umi tumor-normal pass
  • This section has been verified successfully, or been identified as irrelevant for the current verification

Validation and implementation plan status

Pull-request for validation-report made here: https://github.com/Clinical-Genomics/validations/pull/377

  • Validation report signed

Pull-request for implementation-plan here: X

  • Implementation plan signed

mathiasbio and others added 13 commits November 24, 2025 15:46
#### Changed

- increased runtime for a couple of small rules
- decreased memory for headjobs to 500mb
#### Added

- add AT_DROPOUT to all panel analyses QC deliverables
#### Changed

-  lower QSS filter threshold to 10 for WGS TO cases
#### Added

- model validation for reference pydantic models `ReferencesCanFam` and `ReferencesHg`
- `model_config = ConfigDict(extra="forbid")` to both models to warn the user with an error in case extra unknown arguments are provided
- `test_init_CanFam`
- `test_get_reference_output_paths_canfam`
#1651)

#### Added

- The `cytoband_coordinates_file` to `REFERENCE_FILES` dict for `GenomeVersion.HG19`.
	- Specify `"dir_name": "genome"`, file type, name and gzip for the `cytoband_coordinates_file`.
- The `cytoband_coordinates_file` to the `ReferencesHg` model.
- The `cytoband_coordinates_file` to the list returned by `CacheConfig.get_reference_output_paths`.
- The `cytoband_coordinates_file` to the `AnalysisReferencesHg` model and the object returned by `get_analysis_references`.
- The `cytoband_coordinates_file` to  pytest.fixture `fixture_analysis_references_hg_data`.

#### Changed

- `test_get_reference_file_paths_by_compression` to include the additional file.
- `test_get_reference_output_paths` to include the additional file.
- `test_get_reference_file_paths_by_compression` to include the additional file.
#### Added

- added cosmic argument to config case

#### Removed

- removed cosmic download from balsamic init
#### Changed

- change SOR threshold in WGS TO from 3 to 4
#### Fixed

- removes wgs gcbias gc_dropout from deliverables qc (only applicable to WGS)
- removes wgs gcbias at_dropout from deliverables qc (only applicable to WGS)
#### Added

- add new interactive CNV html report for targeted analyses
- add cust-case-id to case config and CNV plots
- add cancer-genelist with cancer genes from custs and oncokb 
- add bcftools split multialleles for DNAscope calls
- add germline vcf to create VAF plot in CNVkit scatter 

#### Changed

- changed DNAscope germline panel bedfile to padded bed
- renamed old CNV pdf report for TGA to signify it is deprecated

#### Removed

- removed unused CNV report snakemake rule
#### Added

- cnv report documentation
@fevac fevac requested a review from a team as a code owner March 26, 2026 08:18
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.38%. Comparing base (0282e70) to head (c6fb066).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1666      +/-   ##
==========================================
+ Coverage   99.33%   99.38%   +0.05%     
==========================================
  Files          40       40              
  Lines        1958     1964       +6     
==========================================
+ Hits         1945     1952       +7     
+ Misses         13       12       -1     
Flag Coverage Δ
unittests 99.38% <100.00%> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fevac fevac changed the title Release v19.0.0 feat: Release v19.0.0 Mar 26, 2026
fevac and others added 5 commits March 26, 2026 15:56
#### Changed

- Changed GC dropout QC threshold for myeloid panel from 1 to 3
#### Removed

- removed cyvcf2 from docs requirements
#### Added

- added a warning about purity and ploidy estimation from PureCN
#### Changed

- increased GC dropout threshold to 3 from 2 for lymphoid panel
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 1, 2026

Quality Gate Failed Quality Gate failed

Failed conditions
C Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

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.

3 participants