From f88ed3ceb563920ef848031283f99148286f25a3 Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Fri, 6 Mar 2026 14:45:37 -0500 Subject: [PATCH 1/2] chore: small fixes to docs, justfile, and release template --- .github/ISSUE_TEMPLATE/release.md | 20 ++++++++++++++------ README.md | 5 ----- justfile | 1 - 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 00cd239..bda5fcd 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -6,13 +6,10 @@ title: "Release MAJOR.MINOR.PATCH" - [ ] Bump the bdk-ffi submodule to the release tag in bdk-ffi. - [ ] Delete the `dist`, `build`, and `bdkpython.egg-info` and rust `target` directories to make sure you are building the library from scratch without any caches. -- [ ] Start the virtual environment. - [ ] Build the library. ```shell just clean -source .localpythonenv/bin/activate -pip install --requirement requirements.txt bash ./scripts/generate-macos-arm64.sh # run the script for your particular platform just build ``` @@ -20,17 +17,28 @@ just build - [ ] Run the tests and adjust if necessary ```shell -pip3 install ./dist/bdkpython--py3-none-any.whl --force-reinstall -python -m unittest --verbose +just install +just test ``` - [ ] Update the readme if necessary - [ ] Create a new branch off of `master` called `release/`, e.g. `release/0.31` - [ ] Update library version from `.dev` version to release version -- [ ] 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. +- [ ] Create the tag for the release and make sure to add a link to the bdk-ffi changelog to the tag. See below for the template of the message we use for tags in this repository. ```shell git tag v0.6.0 --sign --edit +``` + +```md +Release 2.3.1 + +See https://github.com/bitcoindevkit/bdk-ffi/releases/tag/v2.3.1 and https://github.com/bitcoindevkit/bdk-ffi/releases/tag/v2.3.0 as well as our changelog at https://github.com/bitcoindevkit/bdk-ffi/blob/master/CHANGELOG.md for release details. +``` + +- [ ] Push the tag to GitHub, and let the CI run all tests one more time. + +```shell git push upstream v0.6.0 ``` diff --git a/README.md b/README.md index d00977c..80d952c 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,9 @@ This repository uses the bdk-ffi repository as a git submodule. Here are useful ```sh uv sync - bash scripts/generate-macos-arm64.sh - uv build --wheel -v - uv pip install ./dist/bdkpython-.whl --force-reinstall - uv run python -m unittest --verbose ``` @@ -38,6 +34,5 @@ uv run python -m unittest --verbose ```sh uv run python ./docs/generate_docs.py - uv run python -m sphinx -b html -W --keep-going -v docs/source docs/_build/html ``` diff --git a/justfile b/justfile index 745210f..0c1f2d9 100644 --- a/justfile +++ b/justfile @@ -24,7 +24,6 @@ build: [group("Build")] [doc("Install the wheel locally (force reinstall).")] install: - uv venv uv pip install dist/bdkpython-*.whl --force-reinstall [group("Build")] From b1f5c519acb38c51b9a41d26cb9e0ae5ba60c877 Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Fri, 6 Mar 2026 14:46:07 -0500 Subject: [PATCH 2/2] chore: bump dev version of library to 2.4.0-dev0 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 64d0635..6dfe9ad 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "bdkpython" -version = "2.1.0.dev0" +version = "2.4.0.dev0" description = "The Python language bindings for the Bitcoin Development Kit" readme = "README.md" requires-python = ">=3.10"