From 0bef6fc00f92a00560974dc84c32f18f9997c16b Mon Sep 17 00:00:00 2001 From: alemi Date: Wed, 13 Nov 2024 15:09:33 +0100 Subject: [PATCH] docs: added release checklist document --- dist/RELEASING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 dist/RELEASING.md diff --git a/dist/RELEASING.md b/dist/RELEASING.md new file mode 100644 index 0000000..24dbb4a --- /dev/null +++ b/dist/RELEASING.md @@ -0,0 +1,30 @@ +# Release flow + +Releases on registries are automatically handled with GitHub Actions, which will only run on the `stable` branch. + +Every time we merge on `stable` branch, this happens: + - builds and tests core library + - publishes core rust library on `crates.io` (which will rebuild main documentation) + - builds codemp javascript bindings for windows, linux and macos and publishes it on `npm` + - builds codemp python bindings for windows, linux and macos and publishes it on `PyPI` + - builds codemp luajit bindings for windows, linux and macos and publishes it on both `LuaRocks` (source) and codemp.dev/releases (binary) + - builds codemp java bindings for windows, linux and macos and publishes it on `Maven Central` + +# Checklist +Before merging on `stable`, make sure all these steps have been followed + +> do any required change in a branch named `release/vX.Y.Z`, for which a PR can then be opened + +- [ ] `Cargo.toml`: bump version +- [ ] `dist/js/publish/package.json`: make sure version matches with Cargo.toml (also check optionalDependencies! all versions must be the same) +- [ ] `dist/py/pyproject.toml`: make sure version matches with Cargo.toml +- [ ] `dist/java/build.gradle`: make sure version matches with Cargo.toml +- [ ] `dist/lua/codemp-X.Y.Z-1.rockspec`: make sure version matches with Cargo.toml (note that rockspec file contains current version in its name so must be renamed) (note that rockspec versions have a fourth component: "revision". we don't use it so always set is as `1`) +- [ ] update `Cargo.lock` (basically delete it and re-run `cargo build`. check diff before committing!) +- [ ] **make sure docs build without warning or errors** (`cargo doc`) +- [ ] **make sure that core crate builds** with `--release --features=js,py,java,luajit` +- [ ] **make sure the version you're about to release is available** (on all registries!) +- [ ] update last tag in "commits since last tag" badge (in README.md) +- [ ] commit all these changes (in `release/vX.Y.Z` branch), open a PR and have it approved and merged +- [ ] generate a new tag with same version as the one specified in Cargo.toml. include changelog in its description (use `git log ..HEAD --oneline` to get a commit list, but **don't just put it as-is!**). **remember to push the newly generated tag with** (`git push --tags`) +- [ ] merge on `stable` and start release CIs (from your PC: `git checkout dev`, `git pull`, `git checkout stable`, `git pull`, `git merge dev`, `git push`, `git checkout dev`)