-To make a release of Weston and/or Wayland, follow these steps.
+To make a release of Wayland, follow these steps.
0. Verify the test suites and codebase checks pass. All of the
tests should either pass or skip.
$ make check
- 1. For Weston, verify that the wayland and wayland-protocols version
- dependencies are correct, and that wayland-protocols has had a
- release with any needed protocol updates.
-
- 2. Update the first stanza of configure.ac to the intended versions
- for Weston and libweston.
-
- For Weston's x.y.0 releases, if libweston_major_version is greater than
- weston_major_version, bump the Weston version numbers (major, minor,
- micro) to match the libweston version numbers (major, minor, patch).
-
- Additionally for all Weston releases, if libweston's
- major.minor.patch version is less than Weston's major.minor.micro
- version, bump libweston version numbers to match the Weston
- version numbers.
-
- Weston releases are made with the Weston version number, not with the
- libweston version number.
+ 1. Update the first stanza of configure.ac to the intended version.
Then commit your changes:
$ git commit configure.ac -m "configure.ac: bump to version $RELEASE_NUMBER for the $RELEASE_NAME release"
$ git push
- 3. For Weston releases, install Xwayland, either from your distro or
- manually (see http://wayland.freedesktop.org/building.html). If
- you install it to a location other than /usr/bin/Xwayland, specify
- this in the following env var:
-
- XWAYLAND=$(which Xwayland) # Or specify your own path
- export DISTCHECK_CONFIGURE_FLAGS="--with-xserver-path=$XWAYLAND"
-
- If you're using a locally installed libinput or other dependency
- libraries, you'll likely need to set a few other environment
- variables:
-
- export WLD="<path-to-your-local-installation>"
- export LD_LIBRARY_PATH=$WLD/lib
- export PKG_CONFIG_PATH=$WLD/lib/pkgconfig:$WLD/share/pkgconfig/
-
4. Run the release.sh script to generate the tarballs, sign and
upload them, and generate a release announcement template.
This script can be obtained from X.org's modular package:
$ ./publish-doc
5. Compose the release announcements. The script will generate
- *.x.y.z.announce files with a list of changes and tags, one for
- wayland, one for weston. Prepend these with a human-readable
- listing of the most notable changes. For x.y.0 releases, indicate
- the schedule for the x.y+1.0 release.
+ *.x.y.z.announce files with a list of changes and tags. Prepend
+ it with a human-readable listing of the most notable changes.
+ For x.y.0 releases, indicate the schedule for the x.y+1.0
+ release.
- 6. pgp sign the release announcements and send them to
+ 6. PGP sign the release announcements and send them to
wayland-devel@lists.freedesktop.org
7. Update releases.html in wayland-web with links to tarballs and
$ git push
$ ./deploy
- 8. Update topic in #wayland to point to the release announcement URL
-
For x.y.0 releases, also create the release series x.y branch. The x.y
branch is for bug fixes and conservative changes to the x.y.0 release,
and is where we create x.y.z releases from. Creating the x.y branch