You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 and merge that to `master`.
8
+
-[ ] Delete the `target` directory in bdk-ffi and the `build` directory in `lib` to make sure you're building the library from scratch without any caches.
9
+
-[ ] Build the library.
10
+
-[ ] Run the tests and adjust them if necessary.
11
+
12
+
```shell
13
+
just clean
14
+
just build
15
+
just test
16
+
```
17
+
18
+
-[ ] Update the readme if necessary
19
+
-[ ] PR any changes from the steps above if necessary and get them into `master`.
20
+
-[ ] Create a new branch off of `master` called `release/<feature version>`, e.g. `release/2.3`.
21
+
-[ ] Update library version from `SNAPSHOT` version to release version, e.g. `2.0.0-SNAPSHOT` to `2.0.0`.
22
+
-[ ] 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. An example of the tag message would be:
23
+
24
+
```md
25
+
Release 2.2.0
26
+
27
+
For information on this release, see the bdk-ffi repository and [our release notes for the 2.2.0 release](https://github.com/bitcoindevkit/bdk-ffi/releases/tag/v2.2.0) as well as our [Changelog](https://github.com/bitcoindevkit/bdk-ffi/blob/master/CHANGELOG.md).
28
+
```
29
+
30
+
```shell
31
+
git tag v2.3.0 --sign --edit
32
+
# Add message above
33
+
git push upstream v2.3.0
34
+
```
35
+
36
+
-[ ] Trigger release through the workflow dispatch with the new tag.
37
+
-[ ] Bump the version on master while keeping the `SNAPSHOT` suffix, e.g. from `1.1.0-SNAPSHOT` to `1.2.0-SNAPSHOT`.
38
+
-[ ] Update this release workflow if necessary.
39
+
-[ ] Build API docs and push them to the `gh-pages` branch, which will publish them automatically to.
0 commit comments