release-howto.txt 5.93 KB
Newer Older
1 2 3 4 5

                        How to do a GIMP release
                      ----------------------------
                  a check-list for doing a GIMP release

6
 ( ) Announce a string freeze on the GIMP Developer mailing list.
7

8 9 10 11 12
     Mention that a release is planned, what brach will be frozen, and
     how long the string freeze is going to last. Plan for a couple of
     weeks at least. No translatable strings must be touched during
     this time. An example announcement message is:
     https://mail.gnome.org/archives/gimp-developer-list/2016-October/msg00004.html
13

14 15 16 17 18 19 20 21 22 23 24 25
 ( ) Announce the planned release on the GNOME I18N mailing list.

     Let them know about the planned release, what branch it's based
     on, and how many changes to expect. An example message is:
     https://mail.gnome.org/archives/gnome-i18n/2016-October/msg00035.html

 ( ) Wait until the date specified in the announcements, use this time
     to get bug fixes applied which don't modify strings.

 ( ) Check that you have working ssh access to pentagon.gnome.org and
     that you are a member of the gimpadmins group. If not, ask
     Michael Natterer or Michael Schumacher for assistance.
26

27
 ( ) Check that download.gimp.org has enough space to upload the
28 29
     release and to place it into the download area. If not, make
     place or ask Michael Natterer or Michael Schumacher to do that.
30

31
 ( ) Check that you have admin access to the GIMP product on
32 33
     bugzilla.gimp.org and commit access to the gimp-web module, or
     that someone can do the changes for you.
34

35 36 37 38
 ( ) Check if NEWS, authors.xml (and the generated AUTHORS), README or
     INSTALL need to be updated, as well as any release notes on
     gimp.org. Don't forget to add any "Index of new symbols in GIMP
     2.x" to the gtk-doc generated devel-docs.
39

40
 ( ) Does the splash screen need to be changed?
41

42 43 44
 ( ) Bump the version number to an even micro in configure.ac and
     commit this change. It should be the version number of the
     release you are about to make. Releases always have even micro
45 46 47 48 49
     numbers.

     [ ] In configure.ac, modify gimp_micro_version accordingly.

     [ ] In configure.ac, modify gimp_interface_age accordingly.
50

51
 ( ) Make dist tarballs:
52

53 54
     [ ] Start with a checkout of the GIMP tree. Make sure the
         checkout is up to date, clean from uncommitted changes.
55

56 57
     [ ] Run 'git clean -x -d -f' (Warning: you will lose any files
         that are not added).
58

59 60 61 62
     [ ] Run 'git diff'. This should not generate any output, or your
         tree has local modifications.

     [ ] Run ./autogen.sh --enable-gtk-doc
63

64
     [ ] Run 'make' to do a complete build of the source tree.
65

66 67
     [ ] Run 'make distcheck'. Avoid passing make -j since that can
         cause mysterious fails.
68

69
     [ ] If changes to generated files are made by the above command
70 71
         (run 'git diff' to find out), commit+push them and repeat
         from the beginning of this sub-section.
72

73 74
     [ ] If there are problems reported by 'make distcheck', fix
         them. If you made changes in the tree to get 'make distcheck'
75 76
         running, commit+push them and repeat from the beginning of
         this sub-section.
77

78 79
     [ ] If 'make distcheck' passed and created tarballs, go to the
         next item.
80

81 82 83 84
 ( ) A successful run of the 'make distcheck' would create the final
     dist tarballs. It will include a ChangeLog generated from the
     'git log'. Note that we don't bother with any release commit,
     that's what tags are for (see below).
85

86 87 88
 ( ) Tag the release (don't forget to push the tag)
       git tag -s GIMP_2_x_y
       git push origin GIMP_2_x_y
89

90 91 92
 ( ) Bump the version number (past the tagged version) in configure.ac
     to the next odd micro and commit this change. GIT versions always
     have odd micro numbers.
93

94 95 96 97
     [ ] In configure.ac, modify gimp_micro_version accordingly.

     [ ] In configure.ac, modify gimp_interface_age accordingly.

98
 ( ) Publish dist tarballs:
99

100
     [ ] Use md5sum to create a checksum of the tarball (tar.bz2).
101

102 103 104
     [ ] Upload the tarball (tar.bz2) and the .md5 file to your home
         directory on pentagon.gnome.org.  Keep a copy of the .md5
         file around.
105

106
     [ ] Copy the tarball and the .md5 file to its final destination
107 108 109 110
         in the download area (/srv/ftp/pub/gimp/v2.x). Really use
         "cp" not "mv" or SELinux will make the uploaded file
         unreadable to the web server unless some obscure status bit
         is toggled.
111 112 113 114 115 116 117 118

     [ ] Update the 0.0_LATEST-IS- file in the corresponding directory
         on the download server.

     [ ] Change permissions of the new files to make them writable by
         the 'gimpadmins' group. This will allow other members of this
         group to correct mistakes and to update the 0.0_LATEST-IS-
         file next time.
119 120 121

 ( ) Add the new version to the GIMP product on bugzilla.gimp.org.

122 123
 ( ) Check out or update the 'gimp-web' module, check out its testing
     branch.
124

125 126 127 128 129 130
     [ ] Change the file content/downloads/index.md to reference the
         new source release.

     [ ] Create a news items for the release in content/news/

     [ ] Commit and push the changes, the web server should then
131 132
         update itself soon (it checks for updates every 5 minutes).
         Go to https://testing.gimp.org to verify the changes.
133 134

 ( ) Grab a properly chilled beverage and enjoy yourself.
135

136
 ( ) Give the mirrors a reasonably long time to update, then announce
137 138 139 140 141 142 143
     the release on gimp.org and send a release announcement to the
     gimp-user and gimp-developer mailing lists.

     [ ] Check out the gimp-web master branch and merge or cherry-pick
         the changes you did in the testing branch.

     [ ] Push the changes, the web server should then update itself
144 145
         soon (it checks for updates every 15 minutes).
         Go to https://www.gimp.org to verify the changes.
146 147 148 149

     [ ] Due to the tendency of news sites to front-run release
         articles even before actual announcements appear, publish
         everything as fast as possible.