Skip to content

Commit

Permalink
Add releasing process (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
djmitche authored Jan 3, 2025
1 parent 608573d commit cadab77
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
21 changes: 21 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 11 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ classifiers = [
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
authors = [
{name = "Illya Laifu", email="[email protected]"},
{name = "Dustin J. Mitchell", email="[email protected]"},
]
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"]
Expand Down

0 comments on commit cadab77

Please sign in to comment.