Skip to content

Commit

Permalink
Add "How to make a libxkbcommon release"
Browse files Browse the repository at this point in the history
Signed-off-by: Ran Benita <[email protected]>
  • Loading branch information
bluetech committed Dec 19, 2024
1 parent 593a161 commit 09ae46d
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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

- [ ] 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](changes/README.md).

- [ ] 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](https://github.com/xkbcommon/website).

- [ ] 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](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.

0 comments on commit 09ae46d

Please sign in to comment.