Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,39 @@ 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
```

- [ ] Run the tests and adjust if necessary

```shell
pip3 install ./dist/bdkpython-<yourversion>-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/<feature version>`, 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
```

Expand Down
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<yourversion>.whl --force-reinstall

uv run python -m unittest --verbose
```

Expand All @@ -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
```
1 change: 0 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down