frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix minor release issue template

Browse Source
This commit is contained in:
thunderbiscuit 2023-06-16 22:28:09 -04:00
parent 3dd6c203e8
commit 0bfc56b0e8
No known key found for this signature in database
GPG Key ID: 88253696EB836462
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
.github/ISSUE_TEMPLATE/minor_release.md vendored
View File

@ -16,7 +16,7 @@ assignees: ''
3. - [ ] Update the API docs to reflect the changes in the API 3. - [ ] Update the API docs to reflect the changes in the API
4. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch. 4. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch.
5. - [ ] Build the library and run the tests, and adjust if necessary. 5. - [ ] Build the library and run the tests, and adjust if necessary.
```sh ```shell
# start an emulator prior to running the tests # start an emulator prior to running the tests
cd ./bdk-android/ cd ./bdk-android/
./gradlew buildAndroidLib ./gradlew buildAndroidLib
@ -27,7 +27,7 @@ cd ./bdk-android/
7. - [ ] Update the API docs to reflect the changes in the API 7. - [ ] Update the API docs to reflect the changes in the API
8. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch 8. - [ ] Delete the `target` directory in bdk-ffi and all previous artifacts to make sure you're building the library from scratch
9. - [ ] Build the library and run the tests, and adjust if necessary 9. - [ ] Build the library and run the tests, and adjust if necessary
```sh ```shell
cd ./bdk-jvm/ cd ./bdk-jvm/
./gradlew buildJvmLib ./gradlew buildJvmLib
./gradlew test ./gradlew test
@ -35,7 +35,7 @@ cd ./bdk-jvm/
10. - [ ] Update the readme if necessary 10. - [ ] Update the readme if necessary
#### _Swift_ #### _Swift_
11. - [ ] Run the tests and adjust if necessary 11. - [ ] Run the tests and adjust if necessary
```sh ```shell
./bdk-swift/build-local-swift.sh ./bdk-swift/build-local-swift.sh
cd ./bdk-swift/ cd ./bdk-swift/
swift test swift test
@ -59,27 +59,29 @@ python -m unittest --verbose tests/test_bdk.py
### Release Workflow ### Release Workflow
17. - [ ] Update the Android, JVM, Python, and Swift libraries as per the _Specific Libraries' Workflows_ section above. Open a single PR on master for all of these changes called `Prepare language bindings libraries for 0.X release`. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/315). 17. - [ ] Update the Android, JVM, Python, and Swift libraries as per the _Specific Libraries' Workflows_ section above. Open a single PR on master for all of these changes called `Prepare language bindings libraries for 0.X release`. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/315).
- [ ] Create a new branch off of `master` called `release/version` 18. - [ ] Create a new branch off of `master` called `release/version`
18. - [ ] Open a PR to that branch to update the Android, JVM, and Python libraries' versions. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/316). 19. - [ ] Update bdk-android version from `SNAPSHOT` version to release version
- [ ] Update bdk-android version from `SNAPSHOT` version to release version 20. - [ ] Update bdk-jvm version from `SNAPSHOT` version to release version
- [ ] Update bdk-jvm version from `SNAPSHOT` version to release version 21. - [ ] Update bdk-python version from `.dev` version to release version
- [ ] Update bdk-python version from `.dev` version to release version 22. - [ ] Open a PR to that release branch that updates the Android, JVM, and Python libraries' versions in step 19, 20, and 21. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/316).
19. - [ ] Merge the PR updating all the languages to their release versions 23. - [ ] Get a review and ACK and merge the PR updating all the languages to their release versions
20. - [ ] Create the tag and make sure to add the changelog info to the tag (works better if you prepare the tag message on the side in a text editor) and push it to GitHub. 24. - [ ] Create the tag for the release and make sure to add the changelog info to the tag (works better if you prepare the tag message on the side in a text editor). Push the tag to GitHub.
```sh ```shell
git tag v0.6.0 --sign --edit git tag v0.6.0 --sign --edit
git push upstream v0.6.0 git push upstream v0.6.0
``` ```
21. - [ ] Aggregate all the changelog notices from the PRs and add them to the changelog file 25. - [ ] Trigger manual releases for all 4 libraries (for Swift, trigger the release on `master` and simply add the version number in the text field when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`)
22. - [ ] Open a PR on master with the changes to the changelog file and the development versions bump. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/317). 26. - [ ] Make sure the released libraries work and contain the artifacts you would expect
23. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one) 27. - [ ] Aggregate all the changelog notices from the PRs and add them to the changelog file
24. - [ ] Trigger manual releases for all 4 libraries (for Swift, simply add the version number in the text field when running the workflow manually. Note that the version number must not contain the `v`, i.e. `0.26.0`) 28. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0`
25. - [ ] Bump the versions on master from `0.9.0-SNAPSHOT` to `0.10.0-SNAPSHOT`, `0.6.0.dev0` to `0.7.0.dev0` 29. - [ ] Apply changes to the minor_release and patch_release issue templates if they need any
26. - [ ] Build and publish API docs for JVM, Android, and Java on the website 30. - [ ] Open a PR on master with the changes in steps 29, 30, and 31. See [example PR here](https://github.com/bitcoindevkit/bdk-ffi/pull/317). Get a review and merge the PR.
```bash! 31. - [ ] Make release on GitHub (set as pre-release and generate auto release notes between the previous tag and the new one)
32. - [ ] Build and publish API docs for JVM, Android, and Java on the website
```shell
./gradlew dokkaHtml # bdk-jvm (Dokka) ./gradlew dokkaHtml # bdk-jvm (Dokka)
./gradlew dokkaJavadoc # bdk-jvm (java-style documentation) ./gradlew dokkaJavadoc # bdk-jvm (java-style documentation)
./gradlew dokkaHtml # bdk-android (Dokka) ./gradlew dokkaHtml # bdk-android (Dokka)
``` ```
27. - [ ] Tweet about the library 33. - [ ] Post in the announcement channel
28. - [ ] Post in the announcement channel 34. - [ ] Tweet about the library