Skip to content

Commit 3d3bd00

Browse files
committed
add release template.
1 parent d3f22b5 commit 3d3bd00

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed
File renamed without changes.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Preparing a release
2+
3+
## Decide what will be the upcoming version number
4+
5+
- `sbi` currently uses the [Semver 2.0.0](https://semver.org/) convention.
6+
- Edit the version number in the tuple at `sbi/sbi/__version__.py`.
7+
8+
## Collect a list of relevant changes
9+
10+
- [ ] Edit `changelog.md`, add a new version number header and report changes below it.
11+
- [ ] Use one line per change, include links to the pull requests that implemented each of
12+
the changes.
13+
- [ ] **Credit contributors**!
14+
- [ ] If there are new package dependencies or updated version constraints for the existing
15+
dependencies, add/modify the corresponding entries in `pyproject.toml`.
16+
17+
## Run tests locally and make sure they pass
18+
19+
- Run the **full test suite, including slow tests.**
20+
- [ ] slow tests are passing
21+
- [ ] GPU tests are passing
22+
23+
## Upload to pypi
24+
25+
The upload to `pypi` will happen automatically once a release is made
26+
via GitHub.
27+
28+
To do so, **after merging this PR**, you need to
29+
30+
- [ ] copy the new content you added to `changelog.md` to the clipboard
31+
- [ ] draft a new release here: https://github.com/sbi-dev/sbi/releases
32+
- [ ] create a new tag using the `vX.XX.X` scheme
33+
- [ ] paste the content of the `changelog` you copied above and edit it where needed
34+
- [ ] select "pre-release" if needed (default no) or "latest release" (default yes)
35+
- [ ] select "create a discussion" if there are breaking or important changes and users
36+
should have a platform to discuss issues and questions.
37+
- [ ] "publish" or "draft" the release.
38+
39+
Once the release is *published* via Github, the upload to PyPi will be triggered.

0 commit comments

Comments
 (0)