Skip to content

Commit 584668a

Browse files
chore: add release template
1 parent d55eec9 commit 584668a

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

.github/ISSUE_TEMPLATE/release.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: "Release"
3+
about: "Create a new release [for release managers only]"
4+
title: "Release MAJOR.MINOR.PATCH"
5+
---
6+
7+
- [ ] Bump the bdk-ffi submodule to the release tag in bdk-ffi.
8+
- [ ] Delete the `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches.
9+
- [ ] Start the virtual environment.
10+
- [ ] Build the library.
11+
12+
```shell
13+
just clean
14+
source .localpythonenv/bin/activate
15+
pip install --requirement requirements.txt
16+
bash ./scripts/generate-macos-arm64.sh # run the script for your particular platform
17+
just build
18+
```
19+
20+
- [ ] Run the tests and adjust if necessary
21+
22+
```shell
23+
pip3 install ./dist/bdkpython-<yourversion>-py3-none-any.whl --force-reinstall
24+
python -m unittest --verbose
25+
```
26+
27+
- [ ] Update the readme if necessary
28+
- [ ] Create a new branch off of `master` called `release/<feature version>`, e.g. `release/0.31`
29+
- [ ] Update library version from `.dev` version to release version
30+
- [ ] Create the tag for the release and make sure to add a link to the bdk-ffi changelog to the tag. Push the tag to GitHub.
31+
32+
```shell
33+
git tag v0.6.0 --sign --edit
34+
git push upstream v0.6.0
35+
```
36+
37+
- [ ] Trigger release through the workflow dispatch with the new tag.

0 commit comments

Comments
 (0)