release-howto.txt 7.15 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

Jehan's avatar
Jehan committed
8
     Mention that a release is planned, what branch will be frozen, and
9 10 11 12
     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
 ( ) 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

20 21 22
 ( ) Also notify the maintainers of the official builds for Windows,
     Mac OS and flatpak of the upcoming release so they have some time
     to sort out issues with their builds.
23

24
 ( ) If this is a stable release, make sure we have a <release> tag
25 26
     inside desktop/org.gimp.GIMP.appdata.xml.in for this upcoming version.
     Some installers may feature more prominently software with recent
27 28 29 30 31 32
     releases if the appropriate tag was set (e.g. GNOME Software has a
     "Recent Releases" category).
     If a description is added, it may be featured in installers and
     will be translatable (use <_p> or <_li> tags to make the strings
     localizable).

33 34 35 36 37 38
 ( ) 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.
39

40
 ( ) Check that download.gimp.org has enough space to upload the
41 42
     release and to place it into the download area. If not, make
     place or ask Michael Natterer or Michael Schumacher to do that.
43

44
 ( ) Check that you have admin access to the GIMP product on
45 46
     bugzilla.gimp.org and commit access to the gimp-web module, or
     that someone can do the changes for you.
47

48 49 50 51
 ( ) 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.
52

53
 ( ) Does the splash screen need to be changed?
54

55 56 57 58 59 60 61 62 63 64
     Splash requirements:

     [ ] Accepted license: a libre license, such as CC 0, CC by, CC
         by-sa or Free Art.
     [ ] XCF file must be provided.
     [ ] Minimum size: full HD (splash images will be scaled down to 2/3
         of the main display when too bug; but they won't be scaled up.
         Therefore anything smaller than fullHD will look tiny and
         unsuited on a 4K or higher res display).

65 66 67
 ( ) 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
68 69 70 71 72
     numbers.

     [ ] In configure.ac, modify gimp_micro_version accordingly.

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

74
 ( ) Make dist tarballs:
75

76 77
     [ ] Start with a checkout of the GIMP tree. Make sure the
         checkout is up to date, clean from uncommitted changes.
78

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

82 83 84 85
     [ ] Run 'git diff'. This should not generate any output, or your
         tree has local modifications.

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

87
     [ ] Run 'make' to do a complete build of the source tree.
88

89 90
     [ ] Run 'make distcheck'. Avoid passing make -j since that can
         cause mysterious fails.
91

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

96 97
     [ ] If there are problems reported by 'make distcheck', fix
         them. If you made changes in the tree to get 'make distcheck'
98 99
         running, commit+push them and repeat from the beginning of
         this sub-section.
100

101 102
     [ ] If 'make distcheck' passed and created tarballs, go to the
         next item.
103

104 105 106 107
 ( ) 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).
108

109 110 111
 ( ) Tag the release (don't forget to push the tag)
       git tag -s GIMP_2_x_y
       git push origin GIMP_2_x_y
112

113 114 115
 ( ) 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.
116

117 118 119 120
     [ ] In configure.ac, modify gimp_micro_version accordingly.

     [ ] In configure.ac, modify gimp_interface_age accordingly.

121
 ( ) Publish dist tarballs:
122

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

125 126 127
     [ ] 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.
128

129
     [ ] Copy the tarball and the .md5 file to its final destination
130 131 132 133
         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.
134 135 136 137 138 139 140 141

     [ ] 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.
142 143 144

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

145 146
 ( ) Check out or update the 'gimp-web' module, check out its testing
     branch.
147

148 149
     [ ] Update the file 'GIMP_VERSIONS' adding the version, release
         date, tarball name and its MD5 hash under "STABLE".
150 151 152

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

153 154 155 156
     [ ] Run `make authors.md` in GIMP repository. This will generate
         the file `authors.md`. Move it to ./content/about/authors.md on
         the 'gimp-web' module and commit it.

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

161 162
 ( ) Announce the release on gimp.org and send a release announcement
     to the gimp-user and gimp-developer mailing lists.
163 164 165 166 167

     [ ] 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
168 169
         soon (it checks for updates every 15 minutes).
         Go to https://www.gimp.org to verify the changes.
170 171 172 173

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

 ( ) Grab a properly chilled beverage and enjoy yourself.