Release 1.8.0

[wismill]

How to make a libxkbcommon release

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.

• 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 pull && git tag --annotate -m xkbcommon-<MAJOR.MINOR.PATCH> xkbcommon-<MAJOR.MINOR.PATCH>.

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

Send announcement email to wayland-devel

• Send an email to the [email protected] mailing list, using this template:

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

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

---

Fixes #548

[bluetech]

LGTM, just a few wording suggestions.

🥳

[wismill]

@whot may want to have a look too.

[wismill]

Let’s release today.

Reviewing the task, I think it would be better to update the website before the sending the email.

@bluetech do you want to send the email?

[bluetech]

@wismill Sure. I'll go ahead and do all of the remaining steps later tonight.

[bluetech]

Done!