Pileus Git - ~andy/gtk/blob - docs/RELEASE-HOWTO

   1 How to do a GTK+ release?
   2 =========================
   3
   4 Make sure you have suitable versions of autoconf and libtool.
   5 Also make sure you have the following packages installed with all their
   6 dependencies:
   7 * gtk-doc
   8 * docbook-utils
   9 Without those packages make distcheck will *not* pass.
  10 Make sure that gtk-doc is the latest released version.
  11
  12
  13  0) Go back to a pristine working directory. With git, this works:
  14
  15     git clean -f -x
  16
  17  1) autogen and build it, make sure to enable docs by specifying
  18     --enable-gtk-doc --enable-man
  19
  20  2) Update NEWS based on the content of git log; follow the format
  21     of prior entries. This includes finding noteworthy new features,
  22     collecting summaries for all the fixed bugs that are referenced
  23     and collecting all updated translations.
  24     Also collect the names of all contributors that are mentioned.
  25     We don't discriminate between bug reporters, patch writers,
  26     committers, etc. Anybody who is mentioned in ChangeLog gets
  27     credits, but only real names, not email addresses or nicknames.
  28
  29  3) In particular, if this is a major, stable, release, verify that
  30     README.in contains the relevant release notes and that the
  31     required versions of dependencies in INSTALL.in are in sync
  32     with configure.ac.
  33
  34  4) Verify that the version in configure.ac has been bumped after the last
  35     release. (Note that this is critical, a slip-up here will cause the
  36     soname to change).
  37
  38  5) Make sure that make check is happy (If you don't do it here, make distcheck
  39     will also catch it, but it is kind of disheartening to see make distcheck
  40     fail due to an extraneous symbol after watching it build the docs for an
  41     hour...).
  42     Typical problems to expect here (depending on whether this is a devel
  43     snapshot or a stable release):
  44     * forgotten source files
  45     * new symbols missing from .symbols files
  46     * symbols that are exported by should be private (static or _-prefixed)
  47     * symbols that cause PLT entries. This is either caused by using
  48       a in the same library function without including the header or by
  49       using a function from a different library, which is not yet allowed
  50       by the filter in pltcheck.sh
  51
  52  6) If this is a devel release, make sure that the docs for new symbols
  53     are in good shape. Look at the -unused.txt files and add stuff found
  54     there to the corresponding -sections.txt file. Look at the
  55     -undocumented.txt files and see if there is anything in there that
  56     should be documented. If it is, this may be due to typos in the doc
  57     comments in the source. Make sure that all new symbols have proper
  58     Since: tags, and that there is an index in the main -docs.sgml for
  59     the next stable version.
  60
  61  7) make distcheck
  62
  63  8) Fix broken stuff found by 7), repeat
  64
  65  9) Commit all changes: git commit -a. You will have a bunch of po file
  66     changes, NEWS and maybe some doc changes too
  67
  68 10) Now you've got the tarball. Check that the tarball size looks
  69     reasonable compared to previous releases. If the size goes down
  70     a lot, likely the docs went missing for some reason. Or the translations.
  71     If the size goes up by a lot, something else may be wrong.
  72
  73 11) Tag the release. The git command for doing that looks like
  74
  75     git tag -m "GTK+ 2.12.10" 2.12.10
  76
  77 12) Push the tagged commit upstream. The git command for doing that is
  78
  79     git push origin refs/tags/2.12.10
  80
  81 13) Bump the version number in configure.ac and commit and push this change
  82
  83 14) Upload the tarball to master.gnome.org and run install-module to transfer
  84     it to download.gnome.org. If you don't have an account on master.gnome.org,
  85     find someone who can do it for you. The command for this looks like
  86
  87       scp gtk+-2.12.10.tar.gz matthiasc@master.gnome.org:
  88       ssh matthiasc@master.gnome.org
  89       install-module gtk+-2.12.10.tar.gz
  90
  91 15) Get the .bz2 tarball and the .md5sum files back from master.gnome.org
  92     You can probably also create it locally, but I've experienced md5
  93     mismatches when doing so.
  94
  95 16) Upload the .gz and .bz2 tarballs and checksums to ftp.gtk.org and put
  96     them in the right directory below /ftp/pub. Pay attention to correct
  97     ownership, and don't forget to update the LATEST file in the directory.
  98
  99 17) Go to the gnome-announce list archives, find the last announce message,
 100     create a new message in the same form, replacing version numbers,
 101     commentary at the top about "what this release is about" and the
 102     summary of changes.
 103
 104 18) Send it to gnome-announce-list, gtk-list, gtk-app-devel-list and
 105     gtk-devel-list. Set reply-to to desktop-devel-list.
 106
 107 19) Add a link to the release announcement to www.gtk.org which lives
 108     in the gtk-web git module.