From b47e014ed5d13972db0f8f83d5744b646787f296 Mon Sep 17 00:00:00 2001 From: Ran Benita Date: Sun, 15 Dec 2024 13:38:12 +0200 Subject: [PATCH] Add "How to make a libxkbcommon release" Signed-off-by: Ran Benita --- RELEASING.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..021a30fc --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,57 @@ +# How to make a libxkbcommon release + +### Prerequisites + +- Have write access to xkbcommon Git repositories. +- Be subscribed to the [wayland-devel](https://lists.freedesktop.org/mailman/listinfo/wayland-devel) mailing list. + +### Steps + +#### Prepare the release + +- Update the `NEWS.md` file for the release, following the pattern of previous releases. + +- Bump the `version` in `meson.build`. + +- Run `meson dist -C build` to make sure the release is good to go. + +- Commit `git commit -m 'Bump version to MAJOR.MINOR.PATCH'`. + +- Tag `git tag --anotated -m xkbcommon- xkbcommon-`. + +- Push `git push --follow-tags`. + +#### Send announcement email to wayland-devel + +Send an email to the wayland-devel@lists.freedesktop.org mailing list, using this template: + +``` +Subject: [ANNOUNCE] libxkbcommon MAJOR.MINOR.PATCH + + + +Git tag: +-------- + +git tag: xkbcommon- + + +``` + +#### Update website + +- Pull the latest [website repository](https://github.com/xkbcommon/website). + +- Add the doc for the release: `cp -r /build/html doc/`. + +- Update the `current` symlink: `ln -nsrf doc/ doc/current`. + +- Grab a link to the announcement mail from the [wayland-devel archives](https://lists.freedesktop.org/archives/wayland-devel/). + +- Update the `index.html`: + - "Our latest API- and ABI-stable release ..." + - Add entry to the `releases` HTML list. + +- Commit `git commit -m MAJOR.MINOR.PATCH`. + +- Push `git push`. This automatically publishes the website after a few seconds.