[PATCH 2/2] releasing: Add example commands to release directions

Bryce Harrington bryce at osg.samsung.com
Tue Jan 6 14:08:39 PST 2015


Note that for weston, configure.ac needs version numbers updated in
several places.  `make distcheck` for weston no longer triggers the test
suite to run, so update the directions to account for this.  Detail the
commands to run for each step.

Signed-off-by: Bryce Harrington <bryce at osg.samsung.com>
---
 releasing.txt | 52 ++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 38 insertions(+), 14 deletions(-)

diff --git a/releasing.txt b/releasing.txt
index 2debcd0..e14744e 100644
--- a/releasing.txt
+++ b/releasing.txt
@@ -1,29 +1,50 @@
-To make a release follow these steps.
+To make a release of Weston and/or Wayland, follow these steps.
 
-  1.  Update configure.ac to intended version, commit.
+  0.  Update the first three lines of configure.ac to the intended
+      version, commit.  Also note that Weston includes versioned
+      dependencies on 'wayland-server' and 'wayland-client' in
+      configure.ac which typically need updated as well.
 
-  2.  make distcheck (for weston I do make distcheck TESTS= to avoid
-      running the tests... most of the tests pass, but the xwayland one
-      is flaky)
+  1.  Verify the test suites and codebase checks pass.  (All of the
+      tests pass should pass except for xwayland, which can be flaky.)
 
-  3.  git tag -am 1.5.0 1.5.0
+      $ make check
 
-  4.  scp tarballs to /srv/wayland.freedesktop.org/www/releases on
-      annarchy.freedesktop.org
+  2.  Tag the release
 
-  5.  Put SHA1 for tarballs and tagged commits in release announcement
+      $ git tag -am 1.7.0 1.7.0
 
-  6.  Push configure.ac commits and tags.
+  3.  Create the tarballs
 
-  7.  Send out release announcement.
+      $ make distcheck
 
-  8.  Get the release email URL from
+      (If distcheck isn't passing, such as if Wayland's testsuite is
+      failing, you can skip testing via `TESTS= make distcheck`.  Or,
+      if you must, bypass checking entirely via `make dist`.)
+
+  4.  Publish the tarballs
+
+      $ scp <tarballs> annarchy.freedesktop.org:/srv/wayland.freedesktop.org/www/releases/
+
+  5.  Compose a release announcement with the SHA1's, tagged commits,
+      and notable changes.  For x.y.0 releases, indicate
+      the schedule for the x.y+1.0 release.
+
+      $ sha1sum <tarballs>
+
+  6.  Push configure.ac commits and tags
+
+      $ git push origin master 1.7.0
+
+  7.  Send the release announcement to wayland-devel at lists.freedesktop.org
+
+  8.  Get your freshly posted release email URL from
       http://lists.freedesktop.org/archives/wayland-devel/
 
   9.  Update releases.html in wayland-web with links to tarballs and
-      release email.
+      the release email URL
 
-  10. Update topic in #wayland to point to release announcement
+  10. Update topic in #wayland to point to the release announcement URL
 
 For x.y.0 releases, also create the x.y branch.  The x.y branch is for
 bug fixes and conservative changes to the x.y.0 release, and is where
@@ -34,6 +55,9 @@ fixing for the x.y.1 release for a little longer) or before the x.y.0
 release (like we did with the 1.5.0 release, to unblock master
 development early). 
 
+    $ git branch x.y
+    $ git push origin x.y
+
 The master branch configure.ac version should always be (at least)
 x.y.90, with x.y being the most recent stable branch.  Stable branch
 configure version is just whatever was most recently released from
-- 
1.9.1



More information about the wayland-devel mailing list