source: trunk/base/portmgr/ReleaseProcess @ 57872

Last change on this file since 57872 was 57872, checked in by raimue@…, 11 years ago

Add our twitter account to ReleaseProcess

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.9 KB
Line 
1
2= MacPorts Release Process =
3
4This file documents the evolving MacPorts release process.
5$Id: ReleaseProcess 57872 2009-09-17 23:16:24Z raimue@macports.org $
6
7
8== Goals of a Release ==
9
10There are several goals in the release process:
11
12 * Make a specific version of MacPorts available to users.
13 * Archive the materials (code, documentation, etc) that compose the release.
14 * Replicatability: enable the release to be regenerated.
15 * Consistency: codify naming, network locations, etc, for released components.
16 * Ensure that the user base and public is notified of the release.
17
18
19== Steps to a Release ==
20
21The following steps to a release are documented in more detail below:
22
23 * Create an svn branch to carry the release.
24 * Prepare the code for release.
25 * Tag the release.
26 * Create release products: tarballs and dmgs.
27 * Post release products.
28 * Make release version available through selfupdate.
29 * Notify public of the release.
30
31
32=== Create a Release Branch ===
33
34For each major release (i.e. 1.5.x, 1.6.x, etc.) an appropriate branch is created with a
35consistent name. To do this, two things are required:
36
37 * Choose the svn revision from which to create the branch, most likely based off trunk.
38 * Create the branch (e.g. release_1_6) through the svn "copy" command for history preservation,
39   first creating the needed branch directory to preserve the required directory structure
40   (the 'base' directory level *needs* to exist in each release branch, otherwise selfupdate breaks):
41
42 svn mkdir -m "commit-message" http://svn.macports.org/repository/macports/branches/release_1_6
43 svn cp [-r<rev>] -m "commit-message" http://svn.macports.org/repository/macports/trunk/base \
44     http://svn.macports.org/repository/macports/branches/release_1_6
45
46The actual release, alpha or beta releases, release candidates, and any point releases will all
47live on this branch, and tagged appropriately and if necessary (a must for the actual releases,
48optional for beta snapshots) into the /tags svn directory.
49
50Only the base subdirectory, not the ports subdirectory, is branched for a given release.
51
52It is strongly recommended to use the latest version of the subversion port so that merge
53tracking information can be maintained between release branches and trunk/base if you intend
54to merge revisions back and forth between them, which is a very likely scenario.
55
56
57=== Prepare the code for Release ===
58
59In preparation for a release, several things should be completed within the code:
60
61 * Update the file base/ChangeLog in both trunk and the release branch to reflect the appropriate changes.
62 * Update the file base/config/macports_version with the target release number. The content of this file
63   is recorded as the MacPorts version at MacPorts build time, as displayed by the port command, and it's
64   also used by the selfupdate procedure to determine whether a newer version of code is available.
65   It should be different between trunk and the release branch, the former greater to differentiate it from
66   the latter.
67 * Preserve the file base/config/mp_version at the 1.800 fixed value if selfupdate backwards compatibility
68   with pre 1.8.0 MacPorts installations is still desired (cf. svn's r43571).
69 * Update the autoconf 'configure' script through the provided base/regen.sh script once the version number
70   in mp_version has been changed, since the former reads the latter.
71 * Make sure that these and any other changes or bug fixes are made on and/or merged between the release branch
72   and trunk as needed. For instance, if you've made changes to ChangeLog only on the release branch,
73   those changes should be merged back into trunk as well.
74
75
76=== Tag the Release ===
77
78Once the release is ready, it must be tagged so that the release components may be fetched in the future,
79to ensure replicability. Generally, a release candidate is first tagged and built. When and if it is
80approved as the actual release, an additional tag is created that names the same sources.
81
82Tagging conventions:
83
84 * release_1_6_0-rc1 (release candidate 1 for release 1.6.0)
85 * release_1_6_0 (tagged release 1.6.0)
86 * release_1_6_0-archive (tagged release 1.6.0 -- complete archive)
87 * release_1_6_1 (1.6.1 release)
88
89We first tag the branched base directory to make up the final release:
90
91 svn cp -m "commit-message" http://svn.macports.org/repository/macports/branches/release_1_6 \
92     http://svn.macports.org/repository/macports/tags/release_1_6_0
93
94Although only the base subdirectory is branched and tagged for a given major release, we also create a
95separate tag for the entire tree (base sources and full ports tree) at the time the final release tag is
96created (only for major releases, 1.x.0), in order to provide a stake in the ground that specifies a set
97of ports intended to work with that release. Note that this tag incorporates the entire svn trunk directory
98at the revision number at which the final release was tagged.
99
100The necessary working copy to create such a tag is created by checking out all of trunk at the specific
101revision of the final tagging of base and then switching the base directory to the appropriate release
102tag URL. For instance:
103
104 svn co [-r<rev>] http://svn.macports.org/repository/macports/trunk release_1.6.0-archive
105 cd release_1.6.0-archive/base
106 svn switch http://svn.macports.org/repository/macports/tags/release_1_6_0/base
107
108And finally we tag the entire directory as release_1_6_0-archive:
109
110 cd ../../
111 svn cp -m "commit-message" release_1.6.0-archive http://svn.macports.org/repository/macports/tags/release_1_6_0-archive
112
113
114=== Create & Post Release Tarballs ===
115
116The release tarballs are tar.bz2 and tar.gz archives of the base directory only and of the entire svn tree
117for a particular release. They are named with the following naming convention:
118
119 MacPorts-1.6.0.tar.{bz2,gz} (base directory only, corresponding to tag release_1_6_0)
120 MacPorts-1.6.0-archive.tar.{bz2,gz} (complete archives corresponding to tag release_1_6_0-archive)
121
122The following commands issued to the top level Makefile will generate all the tarballs and checksums:
123
124 make ARC=yes DISTVER=1.6.0 distfromsvn
125
126Note that if you omit the "ARC=yes" flag at the start of the make call then the full archive tarballs will not be produced.
127
128All these tarballs are uploaded via svn to the http://svn.macports.org/repository/macports/downloads/MacPorts-1.6.0/
129directory.
130
131Additionally, a file is created, and posted to the same location, that contains md5, sha1, and rmd160 checksums
132for each of the files:
133
134 MacPorts-1.6.0.chk.txt
135 (We should have a way to sign these checksums, and have the signer's keys posted somewhere.
136 Security experts in the project, would you be interested in leading this effort? Eric? Mark? Anyone else?)
137
138
139=== Create Release Disk Image(s) ===
140
141The dmg is a Mac OS X disk image that contains a standalone installer, configured in the usual way, for major
142MacPorts releases (1.x.0), named in a consistent fashion and incorporating the OS version for which it
143was built.
144
145 MacPorts-1.6.0-10.4-Tiger.dmg
146 MacPorts-1.6.0-10.5-Leopard.dmg
147
148To create a disk image, use the MacPorts port. The Portfile will need to be updated to incorporate the
149proper release version and checksums, and the release tarballs will need to be already uploaded to the
150downloads section of the site (wherefrom the sources are fetched by the MacPorts port to build the dmg
151for the release). Make sure the ports tree you're using to build the dmg's is fully up to date.
152
153 sudo port -d dmg MacPorts
154
155Name the dmg appropriately, and generate checksums, which will need to be added to the existing checksums
156file in the downloads directory:
157
158 cd work
159 mv MacPorts-1.6.0.dmg MacPorts-1.6.0-10.5-Leopard.dmg
160 for dmg in MacPorts-1.6.0-*.dmg; do for type in -md5 -sha1 -ripemd160; do openssl dgst $type $dmg; done >> MacPorts-1.6.0.chk.txt; done
161
162These new products, along with the new checksums, also have to be posted to the appropriate downloads
163directory of the MacPorts svn repository. Developers are required to validate the generated installer as
164thoroughly as possible through extensive testing, which is mainly why this step of the release process
165is not automated through a Makefile target or similar. A good way of validating the installer is to first
166create the destroot of the port and examine it for:
167
168 * Linking: libraries and binaries should not be linked against anything that's not present by default
169   on a vanilla Mac OS X installation + developer tools, excluding even the MacPorts installation prefix;
170   this can be accomplished through the use of otool's -L flag. Currently the libraries and binaries in need
171   of linking validation are:
172             ${destroot}/Library/Tcl/macports1.0/MacPorts.dylib
173             ${destroot}/opt/local/bin/daemondo
174             ${destroot}/opt/local/share/macports/Tcl/darwintrace1.0/darwintrace.dylib
175             ${destroot}/opt/local/share/macports/Tcl/pextlib1.0/Pextlib.dylib
176             ${destroot}/opt/local/share/macports/Tcl/registry2.0/registry.dylib
177 * Universal building: When building for Tiger and above, all the files that need linking confirmation in the
178   step above also need to be confirmed of the universal type. A way to do this is through the file(1) command:
179             file ${destroot}/opt/local/bin/daemondo:
180                  ${destroot}/opt/local/bin/daemondo: Mach-O universal binary with 2 architectures
181                  ${destroot}/opt/local/bin/daemondo (for architecture ppc):  Mach-O executable ppc
182                  ${destroot}/opt/local/bin/daemondo (for architecture i386): Mach-O executable i386
183 * tclsh shell invoked by our scripts: all scripts installed in ${destroot}/opt/local/bin (that is port,
184   portindex and portmirror) should invoke the tclsh shell through a call like:
185             #!/bin/sh
186             #\
187             exec /usr/bin/tclsh "$0" "$@"
188   thus ensuring that the default Mac OS X bundled Tcl is used in our scripts.
189 * macports1.0 Tcl package: The macports1.0 Tcl package should be sourced off its default location in /Library/Tcl/macports1.0
190   in every single one of our scripts in ${destroot}/opt/local/bin.
191 * Miscellaneous: anything else that might seem out of the ordinary for a fully default-configured MacPorts
192   installation.
193
194Once the above requirements have been positively asserted, the one remaining test is to make sure that the
195dmg mounts in the Finder when double-clicked, and that the pkg contained therein properly starts up Installer.app
196when it's double-clicked.
197
198
199=== Make the Release Available through Self-Update ===
200
201In order to make the release version available through selfupdate, the base/config/RELEASE_URL file in svn
202trunk needs to be updated with the tag of the release to distribute. This file is read by the cron job that
203makes the code available via rsync. See base/portmgr/mprsyncup. Though not strictly necessary, it's also good
204practice to update the same file accordingly in its branched guise.
205
206
207=== Update trunk's version for next release ===
208Once trunk is to be used for development of the next major version, increase its version information to
209indicate it's moved past the release version by setting the patch-level version to 99, e.g., 1.8.99 (in
210trunk/base/config/macports_version).
211
212
213=== Notify the Public of the Release ===
214
215Once the release has been posted, notification of the release should be sent/posted to the following places:
216
217 * The macports-announce@, macports-users@ and macports-dev@ mailing lists.
218 * The MacPorts website, by adapting the $macports_version_major and $macports_version_latest variables as appropriate in the trunk/www/includes/common.inc file.
219 * [http://trac.macports.org/news/] The MacOSforge news section (submitter: portmgr@)
220 * [http://www.apple.com/downloads/macosx/unix_open_source/macports.html Apple's downloads page] (submitter: jmpp@)
221 * [http://freshmeat.net/projects/macports/ Freshmeat] (submitter: mww@)
222 * [http://www.versiontracker.com/dyn/moreinfo/macosx/26679 VersionTracker] (submitter: mij@)
223 * [http://sourceforge.net/projects/macports/ sourceforge] (submitted: rhwood@)
224 * [http://www.macupdate.com/info.php/id/21309/macports MacUpdate] (submitter: ???)
225 * [http://twitter.com/macports twitter] (submitter: raimue@)
226 * (Where else?)
Note: See TracBrowser for help on using the repository browser.