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

Fix the crate version in src/lib.rs

Browse Source
This commit is contained in:
Alekos Filini 2021-01-26 09:34:14 -05:00
parent df32c849bb
commit 2e0ca4fe05
No known key found for this signature in database
GPG Key ID: 431401E4A4530061
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
DEVELOPMENT_CYCLE.md
View File

@ -32,13 +32,14 @@ Pre-`v1.0.0` our "major" releases only affect the "minor" semver value. Accordin
- If it's a minor issue you can just fix it in the release branch, since it will be merged back to `master` eventually - 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 - For bigger issues you can fix them on `master` and then *cherry-pick* the commit to the release branch
6. Update the changelog with the new release version. 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". 7. Update `src/lib.rs` with the new version (line ~59)
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. 8. 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".
9. Push the new commits to the upstream release branch, wait for the CI to finish one last time. 9. 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.
10. Publish **all** the updated crates to crates.io. 10. Push the new commits to the upstream release branch, wait for the CI to finish one last time.
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". 11. Publish **all** the updated crates to crates.io.
12. Merge the release branch back into `master`. 12. 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".
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. 13. Merge the release branch back into `master`.
14. Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs. 14. 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.
15. Announce the release on Twitter, Discord and Telegram. 15. Make sure the new release shows up on crates.io and that the docs are built correctly on docs.rs.
16. Celebrate :tada: 16. Announce the release on Twitter, Discord and Telegram.
17. Celebrate :tada:

2
src/lib.rs
View File

@ -56,7 +56,7 @@
//! interact with the bitcoin P2P network. //! interact with the bitcoin P2P network.
//! //!
//! ```toml //! ```toml
//! bdk = "0.2.0" //! bdk = "0.3.0"
//! ``` //! ```
//! //!
//! ## Sync the balance of a descriptor //! ## Sync the balance of a descriptor