Checklists

Releases

Prerequisites:

Have all issues done for the next milestone.

Tasks:

Create ticket with the following template and assign it to the proper milestone.

Release for version vVERSION

- [ ] edit `HISTORY.rst` and ensure a proper section is added
- [ ] edit `admin_upgrade.rst` to reflect the upgrade instructions
- [ ] create a git tag `v.MAJOR.MINOR.PATCH` and `git push --tags`
- [ ] create a "Github release` based on the tag with the text

      ```
      All details can be found in the `HISTORY.rst` file.
      ```

Follow through the items.

Data & Software Validation

Prerequisites:

Have all background data imported into dedicated instances for validation. (Internally we use varfish-build-release-{37,38}.cubi.bihealth.org).
Create the varfish-site-data-X.tar.gz tarball with the database dump.
Have a token ready for the root user.

Tasks:

Create a ticket with the following template.

Validate data for:

- **VarFish:** vMAJOR.MINOR.PATCH
- **Site Data:** vVERSION (`sha256:CHECKSUM`)
- **Genome Build:** GRCh37 or GRCh38

Result Reports:

PASTE HERE

Use the varfish-wf-validation Snakemake workflow for running the validation.
Paste the result reports into the tickets.