]> Untitled Git - bdk-cli/commitdiff
docs: removed changelog section from pr template github/ci/add_release_plz
authorSteve Myers <steve@notmandatory.org>
Wed, 23 Sep 2026 15:41:48 +0000 (10:41 -0500)
committerSteve Myers <steve@notmandatory.org>
Fri, 25 Sep 2026 02:59:32 +0000 (21:59 -0500)
The release_plz workflow will use conventional
commit messages to update the CHANGELOG.

Also removed the API breaking checkbox in the
pull_request_template.md since it doesn't apply
to binary apps like bdk-cli and removed the now
unneeded minor_release.md template.

.github/ISSUE_TEMPLATE/minor_release.md [deleted file]
.github/pull_request_template.md
.github/workflows/release-plz.yml

diff --git a/.github/ISSUE_TEMPLATE/minor_release.md b/.github/ISSUE_TEMPLATE/minor_release.md
deleted file mode 100644 (file)
index feb0f64..0000000
+++ /dev/null
@@ -1,68 +0,0 @@
----
-name: Minor Release
-about: Create a new minor release [for release managers only]
-title: 'Release MAJOR.MINOR+1.0'
-labels: 'release'
-assignees: ''
-
----
-
-## Create a new minor release
-
-### Summary
-
-<--release summary to be used in announcements-->
-
-### Commit
-
-<--latest commit ID to include in this release-->
-
-### Changelog
-
-<--add notices from PRs merged since the prior release, see ["keep a changelog"]-->
-
-### Checklist
-
-Release numbering must follow [Semantic Versioning]. These steps assume the current `master`
-branch **development** version is *MAJOR.MINOR.0*.
-
-#### On the day of the feature freeze
-
-Change the `master` branch to the next MINOR+1 version:
-
-- [ ] Switch to the `master` branch.
-- [ ] Create a new PR branch called `bump_dev_MAJOR_MINOR+1`, eg. `bump_dev_0_22`.
-- [ ] Bump the `bump_dev_MAJOR_MINOR+1` branch to the next development MINOR+1 version.
-  - Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0`.
-  - The commit message should be "Bump version to MAJOR.MINOR+1.0".
-- [ ] Create PR and merge the `bump_dev_MAJOR_MINOR+1` branch to `master`.
-  - Title PR "Bump version to MAJOR.MINOR+1.0".
-
-#### On the day of the release
-
-Tag and publish new release:
-
-- [ ] Double check that your local `master` is up-to-date with the upstream repo.
-- [ ] Create a new branch called `release/MAJOR.MINOR+1` from `master`.
-- [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch.
-  - The tag name should be `vMAJOR.MINOR+1.0`
-  - The first line of the tag message should be "Release MAJOR.MINOR+1.0".
-  - In the body of the tag message put a copy of the **Summary** and **Changelog** for the release.
-  - Make sure the tag is signed, for extra safety use the explicit `--sign` flag.
-- [ ] Wait for the CI to finish one last time.
-- [ ] Push the new tag to the `bitcoindevkit/bdk-cli` repo.
-- [ ] Publish **all** the updated crates to crates.io.
-- [ ] Create the release on GitHub.
-  - Go to "tags", click on the dots on the right and select "Create Release".
-  - Set the title to `Release MAJOR.MINOR+1.0`.
-  - In the release notes body put the **Summary** and **Changelog**.
-  - Use the "+ Auto-generate release notes" button to add details from included PRs.
-  - Until we reach a `1.0.0` release check the "Pre-release" box.
-- [ ] Make sure the new release shows up on [crates.io] and that the docs are built correctly on [docs.rs].
-- [ ] Announce the release, using the **Summary**, on Discord, Twitter and Mastodon.
-- [ ] Celebrate ðŸŽ‰
-
-[Semantic Versioning]: https://semver.org/
-[crates.io]: https://crates.io/crates/bdk-cli
-[docs.rs]: https://docs.rs/bdk-cli/latest/bdk-cli
-["keep a changelog"]: https://keepachangelog.com/en/1.0.0/
index fe8a5a4eab3e6883bcf542074a3f82a563c43276..ca298a079fec5e92bbbcde5eaa884945cca6fe5f 100644 (file)
@@ -9,11 +9,6 @@
 <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
 of the PR were done in a specific way -->
 
-## Changelog notice
-
-<!-- Notice the release manager should include in the release tag message changelog -->
-<!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
-
 ### Checklists
 
 #### All Submissions:
@@ -26,10 +21,8 @@ of the PR were done in a specific way -->
 
 * [ ] I've added tests for the new feature
 * [ ] I've added docs for the new feature
-* [ ] I've updated `CHANGELOG.md`
 
 #### Bugfixes:
 
-* [ ] This pull request breaks the existing API
 * [ ] I've added tests to reproduce the issue which are now passing
 * [ ] I'm linking the issue being fixed by this PR
index 8c9fa473fa8a0bd7c3f8e21fd5caf52b29f5c3dd..c4f6258f7a364d80fac35c2ea94025e756aeb59d 100644 (file)
@@ -14,7 +14,7 @@ name: Release-plz
 #    Re-run it to refresh the release PR after new commits land on the branch.
 # 2. The `release` job checks whether the release PR has been merged. If so, it
 #    publishes the crate to crates.io (via trusted publishing / OIDC, no token
-#    secret) and creates the `<crate>-vX.Y.Z` git tag and GitHub release.
+#    secret) and creates the `vX.Y.Z` git tag and GitHub release.
 #    The job runs in the `release` GitHub environment, whose required reviewers
 #    are defined in the GitHub repository config; publishing waits until an
 #    authorized GitHub user approves it in the Actions UI.