Skip to content

Commit

Permalink
RELEASING updates
Browse files Browse the repository at this point in the history
  • Loading branch information
djmitche committed Jan 3, 2025
1 parent 8185ce7 commit 9ffd6d6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "taskchampion-py"
version = "0.7.0.1-pre"
version = "0.7.0"
edition = "2021"
# This should match the MSRV of the `taskchampion` crate.
rust-version = "1.78.0"
Expand Down
23 changes: 13 additions & 10 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
# Release process

(WIP)

Releases should be co-versioned with the TaskChampion version. If an additional
taskchampion-py release is required with the same TaskChampion version, use a
TaskChampion-Py release is required with the same TaskChampion version, use a
fourth number, e.g., `1.2.0.1`.

## Bumping TaskChampion Version

To bump the TaskChampion version, update both the `package.version` and
`dependencies.taskchampion.version` properties in `Cargo.toml`, and update
`project.version` in `pyproject.toml`.

## Releasing TaskChampion-Py

1. Run `git pull upstream main`
1. Edit `Cargo.toml` to remove the `-pre` prefix from the version.
1. Run `cargo build`.
1. Commit the changes (Cargo.lock will change too) with comment `vX.Y.Z`.
1. Verify that the version in `pyproject.toml` is correct.
1. Run `git tag vX.Y.Z`
1. Run `git push upstream`
1. Run `git push upstream tag vX.Y.Z`
1. Bump the fourth version number in `Cargo.toml`, e.g., from `1.2.0` to `1.2.0.1-pre`.
1. Run `cargo build` again to update `Cargo.lock`
1. Commit that change with comment "Bump to -pre version".
1. Bump the fourth version number in `pyproject.toml`, e.g., from `1.2.0` to `1.2.0.1`.
1. Commit that change with comment "Bump to next version".
1. Run `git push upstream`
1. Navigate to the tag commit in the GitHub UI and watch the build complete. It should produce a release on PyPI when complete
1. Navigate to the tag commit in the [GitHub Actions UI](https://github.com/GothenburgBitFactory/taskchampion-py/actions) and watch the build complete. It should produce a release on PyPI when complete
1. Navigate to the tag in the GitHub Releases UI and make a Release for this version, summarizing contributions and important changes.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ build-backend = "maturin"

[project]
name = "taskchampion-py"
version = "0.7.0"
requires-python = ">=3.9"
classifiers = [
"Programming Language :: Rust",
Expand All @@ -14,7 +15,6 @@ authors = [
{name = "Illya Laifu", email="[email protected]"},
{name = "Dustin J. Mitchell", email="[email protected]"},
]
dynamic = ["version"]
license = {file = "LICENSE"}
readme = "README.md"

Expand Down

0 comments on commit 9ffd6d6

Please sign in to comment.