Skip to content

Checklists

The purpose of this page is to collate a series of checklists for commonly performed changes to the source code of Uno.

In each case, copy the checklist into the description of the pull request.

Making a release of Uno

In preparation for an Uno release, use the following checklist. These steps can be done in the same commit, or separately.

## Pre-release

- [ ] Change the version number in `CITATION.cff` (twice)
- [ ] Change the version number in `CMakeLists.txt`
- [ ] Change the version number in `interfaces/C/Uno_C_API.h`
- [ ] Change the version number in `interfaces/Julia/gen/prologue_fortran.f90`
- [ ] Update the logo in `docs/figures/logo.png`
- [ ] The PR should have the title `Prep for vX.Y.Z.`
- [ ] The commit messages in this PR do not contain `[ci skip]`

## Post-release

- `Uno_jll.jl` and `UnoSolver.jl`
  - [ ] Update the [Yggdrasil tarballs](https://github.com/JuliaPackaging/Yggdrasil/blob/master/U/Uno/build_tarballs.jl)
  - [ ] Change the `Uno_jll` version number in `interfaces/Julia/Project.toml`
  - [ ] Change the `Uno_jll` version number in `interfaces/Julia/gen/Project.toml`
  - [ ] Change the patch version number in `interfaces/Julia/Project.toml`
- [ ] Update the logo in [the Github settings](https://github.com/cvanaret/Uno/settings)

Making a release of UnoSolver.jl

In preparation for an UnoSolver.jl release, use the following checklist.

## Pre-release

- [ ] Change the version number in `interfaces/Julia/Project.toml`
- [ ] The title of the PR should start with `[UnoSolver.jl] Release`
- [ ] Tag the register bot in a commit: `@JuliaRegistrator register subdir="interfaces/Julia"

Making a release of unopy

In preparation for an unopy release, use the following checklists: first for the test release to TestPyPI and the corresponding tests with pip install, then for the actual release to PyPI and the corresponding tests with pip install.

## Test release

- [ ] Change the version number in `pyproject.toml`
- [ ] The title of the test commit should start with `[unopy] Test release`

## Pre-release

- [ ] Change the version number in `pyproject.toml`
- [ ] The title of the PR should start with `[unopy] Release`