From 9ffd6d61b87b4924758aba00d4b6b664480e88e5 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Thu, 2 Jan 2025 23:07:06 -0500 Subject: [PATCH] RELEASING updates --- Cargo.toml | 2 +- RELEASING.md | 23 +++++++++++++---------- pyproject.toml | 2 +- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 1765382..b58ee89 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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" diff --git a/RELEASING.md b/RELEASING.md index 7c70107..f08fcd2 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -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. diff --git a/pyproject.toml b/pyproject.toml index 168331d..9427871 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,6 +4,7 @@ build-backend = "maturin" [project] name = "taskchampion-py" +version = "0.7.0" requires-python = ">=3.9" classifiers = [ "Programming Language :: Rust", @@ -14,7 +15,6 @@ authors = [ {name = "Illya Laifu", email="illyalaifu@gmail.com"}, {name = "Dustin J. Mitchell", email="dustin@v.igoro.us"}, ] -dynamic = ["version"] license = {file = "LICENSE"} readme = "README.md"