-
Notifications
You must be signed in to change notification settings - Fork 124
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add "How to make a libxkbcommon release"
Signed-off-by: Ran Benita <[email protected]>
- Loading branch information
Showing
1 changed file
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 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'`. | ||
|
||
- Tag `git tag --anotated -m xkbcommon-<MAJOR.MINOR.PATCH> xkbcommon-<MAJOR.MINOR.PATCH>`. | ||
|
||
- Push `git push --follow-tags`. | ||
|
||
#### 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> | ||
<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>`. | ||
|
||
- 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. |