From cadab77fd94367978312e558f4dd070aaafd20c8 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Thu, 2 Jan 2025 22:53:13 -0500 Subject: [PATCH] Add releasing process (#29) --- RELEASING.md | 21 +++++++++++++++++++++ pyproject.toml | 11 +++++++++++ 2 files changed, 32 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..7c70107 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,21 @@ +# 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 +fourth number, e.g., `1.2.0.1`. + +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. 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. 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 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 4e1af37..168331d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,7 +10,18 @@ classifiers = [ "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", ] +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" + +[project.urls] +homepage = "https://gothenburgbitfactory.org/taskchampion" +repository = "https://github.com/GothenburgBitFactory/taskchampion-py" +changelog = "https://github.com/GothenburgBitFactory/taskchampion-py/releases" [tool.maturin] features = ["pyo3/extension-module"]