Skip to content

Commit 97dfd2c

Browse files
add release checklist
1 parent b9d85b1 commit 97dfd2c

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Release checklist
3+
about: Checklist to make a release
4+
title: ''
5+
labels: 'maintenance'
6+
assignees: ''
7+
8+
---
9+
10+
# CADET-Python Release Checklist
11+
12+
CADET-Python follows the semantic versioning system described at [semver.org](https://semver.org/).
13+
14+
CADET-Python is released direcntly from the master branch and deployed to PyPi via a GitHub workflow.
15+
16+
The following checklist describes the steps to execute sequentially for creating a new release.
17+
18+
---
19+
20+
## Preparation
21+
22+
- [ ] Create a version bump commit `Bump version to vX.X.X`:
23+
- Update the version number in
24+
- `__init__.py`
25+
- `zenodo.json` (two places), `cadet.hpp` and
26+
27+
---
28+
29+
## Creating the release on GitHub
30+
31+
- [ ] Go to [GitHub Releases](https://github.com/cadet/CADET-Core/releases/new):
32+
- Set the release branch as the target
33+
- Specify the tag `vX.X.X` according to semantic versioning
34+
- Add release notes with sections for Added, Fixed, Changed, and Updated
35+
- Publish the release.
36+
- [ ] Check creation of docker image with the new release
37+
- [ ] Verify Zenodo archiving:
38+
- Confirm that a version-specific DOI was created
39+
- Ensure that the source code and associated files are archived
40+
- Note that the [concept DOI](https://doi.org/10.5281/zenodo.14132721) remains constant
41+
42+
---
43+
44+
## Follow-up
45+
- [ ] If this release checklist was updated, add these changes to the corresponding issue template

0 commit comments

Comments
 (0)