From cf4380b7eef0d4790d81e4e97d06f2ec11382597 Mon Sep 17 00:00:00 2001 From: Joris Vaillant Date: Wed, 12 Feb 2025 13:27:55 +0100 Subject: [PATCH] dev: Document how to release --- development/release.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 development/release.md diff --git a/development/release.md b/development/release.md new file mode 100644 index 000000000..870b71ea6 --- /dev/null +++ b/development/release.md @@ -0,0 +1,34 @@ +# Release with Pixi + +To create a release with Pixi run the following commands on the **devel** branch: + +```bash +COAL_VERSION=X.Y.Z pixi run release_new_version +git push origin +git push origin vX.Y.Z +git push origin devel:master +``` + +Where `X.Y.Z` is the new version. +Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules. + +You will find the following assets: +- `./build_new_version/coal-X.Y.Z.tar.gz` +- `./build_new_version/coal-X.Y.Z.tar.gz.sig` + +Then, create a new release on [GitHub](https://github.com/coal-library/coal/releases/new) with: + +* Tag: vX.Y.Z +* Title: Coal X.Y.Z +* Body: +``` +## What's Changed + +CHANGELOG CONTENT + +**Full Changelog**: https://github.com/coal-library/coal/compare/vXX.YY.ZZ...vX.Y.Z +``` + +Where `XX.YY.ZZ` is the last release version. + +Then upload `coal-X.Y.Z.tar.gz` and `coal-X.Y.Z.tar.gz.sig` and publish the release.