Skip to content

RELEASING.md

Latest commit

 

History

History
83 lines (50 loc) · 2.87 KB

RELEASING.md

File metadata and controls

83 lines (50 loc) · 2.87 KB

How to make a libxkbcommon release

Prerequisites

  • Have write access to xkbcommon Git repositories.
  • Be subscribed to the wayland-devel mailing list.

Steps

Prepare the release

  • Ensure there is no issue in the tracker blocking the release. Make sure they have their milestone set to the relevant release and the relevant tag “critical”.

  • Ensure all items in the current milestone are processed. Remaining items must be explicitly postponed by changing their milestone.

  • Ensure the keysyms header is up-to-date (see xorgproto)

  • Create a release branch: git checkout -b release/vMAJOR.MINOR.PATCH master

  • Update the NEWS.md file for the release, following the corresponding instructions.

  • 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'.

  • Create a pull request using this template and ensure all CI is green.

  • Merge the pull request.

  • Tag git switch master && git pull && git tag --annotate -m xkbcommon-<MAJOR.MINOR.PATCH> xkbcommon-<MAJOR.MINOR.PATCH>.

  • Push the tag git push origin xkbcommon-<MAJOR.MINOR.PATCH>.

Send announcement email to wayland-devel

Subject: [ANNOUNCE] libxkbcommon MAJOR.MINOR.PATCH

<NEWS & comments for this release>

Git tag:
--------

git tag: xkbcommon-<MAJOR.MINOR.PATCH>
git commit: <git commit sha>

<YOUR NAME>

Update website

  • Pull the latest website repository.

  • Add the doc for the release: cp -r <xkbommon>/build/doc/html doc/<MAJOR.MINOR.PATCH>. Check carefully that there is no warning during generation with Doxygen. It may be necessary to use another version of Doxygen to get a clean build. Building from source using the main branch is also a good option.

  • Apply manual Doxygen fixes:

    • Fix labels of the TOC in the “Release notes” page.

  • Update the current symlink: ln -nsrf doc/<MAJOR.MINOR.PATCH> doc/current.

  • Grab a link to the announcement mail from the wayland-devel archives.

  • 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.