]> Untitled Git - bdk/commitdiff
Fix the changelog after release v0.2.0
authorAlekos Filini <alekos.filini@gmail.com>
Mon, 21 Dec 2020 15:36:29 +0000 (16:36 +0100)
committerAlekos Filini <alekos.filini@gmail.com>
Mon, 21 Dec 2020 19:14:23 +0000 (20:14 +0100)
CHANGELOG.md
DEVELOPMENT_CYCLE.md

index 7527af7d491b4409770b8ff900de6f66c3e63f8e..76fd693500cdc0abf869b9f5864994bdcd09dd2c 100644 (file)
@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v0.2.0] - [0.1.0-beta.1]
+
 ### Project
 #### Added
 - Add CONTRIBUTING.md
@@ -209,5 +211,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use `MemoryDatabase` in the compiler example
 - Make the REPL return JSON
 
-[unreleased]: https://github.com/bitcoindevkit/bdk/compare/0.1.0-beta.1...HEAD
+[unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.2.0...HEAD
 [0.1.0-beta.1]: https://github.com/bitcoindevkit/bdk/compare/96c87ea5...0.1.0-beta.1
+[v0.2.0]: https://github.com/bitcoindevkit/bdk/compare/0.1.0-beta.1...v0.2.0
index 0f05846d1e4dd0d295246b283b14d29c1eb206b7..ed5cb3642865d086ebf0a7c3bf7b23aecb61ff60 100644 (file)
@@ -35,12 +35,14 @@ Pre-`v1.0.0` our "major" releases only affect the "minor" semver value. Accordin
 5. If a bug is found:
     - If it's a minor issue you can just fix it in the release branch, since it will be merged back to `master` eventually
     - For bigger issues you can fix them on `master` and then *cherry-pick* the commit to the release branch
-6. On release day, make a commit on the release branch to bump the version to `x.y.z`. The message should be "Bump version to x.y.z".
-7. Add a tag to this commit. The tag name should be `vx.y.z` (for example `v0.5.0`), and the message "Release x.y.z". Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
-8. Push the new commits to the upstream release branch, wait for the CI to finish one last time.
-9. Publish **all** the updated crates to crates.io.
-10. Make a new commit to bump the version value to `x.y.(z+1)-dev`. The message should be "Bump version to x.y.(z+1)-dev".
-11. Merge the release branch back into `master`.
-12. Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs.
-13. Announce the release on Twitter, Discord and Telegram.
-14. Celebrate :tada:
+6. Update the changelog with the new release version
+7. On release day, make a commit on the release branch to bump the version to `x.y.z`. The message should be "Bump version to x.y.z".
+8. Add a tag to this commit. The tag name should be `vx.y.z` (for example `v0.5.0`), and the message "Release x.y.z". Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
+9. Push the new commits to the upstream release branch, wait for the CI to finish one last time.
+10. Publish **all** the updated crates to crates.io.
+11. Make a new commit to bump the version value to `x.y.(z+1)-dev`. The message should be "Bump version to x.y.(z+1)-dev".
+12. Merge the release branch back into `master`.
+13. Create the release on GitHub: go to "tags", click on the dots on the right and select "Create Release". Then set the title to `vx.y.z` and write down some brief release notes.
+14. Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs.
+15. Announce the release on Twitter, Discord and Telegram.
+16. Celebrate :tada: