README.releasing

   1 The GNOME Utilities project follows some rules on how to make a release:
   2
   3   - If this is your first release, please go to:
   4
   5       http://live.gnome.org/MaintainersCorner/Releasing
   6
   7     and read up. The gnome-utils project follows a slightly different
   8     process but you should familiarise yourself with the official
   9     guidelines anyway.
  10
  11   - Clean up the repository using:
  12
  13         git clean -xdf
  14
  15     this will remove any non-tracked file from the repository; make sure
  16     you don't have new files you haven't committed first!
  17
  18   - Regenerate the build environment using:
  19
  20         ./autogen.sh --enable-gtk-doc
  21
  22     the '--enable-gtk-doc' bit is mandatory as long as we ship with
  23     the libgdict API reference.
  24
  25   - Make all
  26
  27   - Run:
  28
  29       make distcheck
  30
  31     and verify that a tarball is created and distcheck passes. If the
  32     distcheck does not pass fix any issue you find.
  33
  34   - Edit the NEWS file for the new release. The header for the release
  35     section is:
  36
  37 ====================================================================
  38 GNOME Utilities X.YY.ZZ (DAY MONTH YEAR) - "CODENAME"
  39
  40     Usually the code name is the title of a song. After the header goes
  41     the shortlog generated by using:
  42
  43         git shortlog (X.YY.ZZ - 1)..
  44
  45     where (X.YY.ZZ - 1) is the tag for the previous release, e.g.:
  46
  47         git shortlog 2.27.1..
  48
  49     This will generate the list of commits, broken down by author
  50     name, since the last release.
  51
  52   - Edit the README file to change the version and code name for the
  53     release.
  54
  55   - Commit the changes using:
  56
  57       git commit -m "[release] X.YY.ZZ" NEWS README
  58
  59   - Run:
  60
  61       make distcheck
  62
  63     again. This will generate a ChangeLog up to the release commit.
  64
  65   - When distcheck ends, move the tarball in another directory and
  66     double check the last changes. Then copy it to gnome.org for
  67     the release process.
  68
  69   - Tag the release using:
  70
  71       git tag -s -m "Release X.YY.ZZ" X.YY.ZZ
  72
  73     Do NOT tag using something like "GNOME_UTILS_X_YY_ZZ". Tags like
  74     that will be ignored and a new "X.YY.ZZ" tag will be used instead.
  75
  76   - Bump up the version number in configure.ac and commit.
  77
  78   - Push the newly created tag and then push the branch, e.g.:
  79
  80       git push origin X.YY.ZZ
  81       git push origin master
  82
  83   - SSH into gnome.org and call install-module on the tarball you
  84     previously uploaded.
  85
  86   - Send the release announcement to gnome-utils-list@gnome.org and
  87     CC: gnome-announce-list@gnome.org.
  88
  89 Any change to the release process MUST be discussed with the rest of
  90 the maintainers.