source: trunk/base/ReleaseProcess @ 25570

Last change on this file since 25570 was 24811, checked in by jmpp@…, 13 years ago

Merge r24791 back into trunk: Updates to download links in the ReleaseProcess file.

File size: 8.5 KB
2== MacPorts Release Process ==
4This page documents the evolving MacPorts release process.
7== Goals of a Release ==
9There are several goals in the release process:
11* Make a specific version of MacPorts available to users.
12* Archive the materials (code, documentation, etc) that compose the release.
13* Replicatability: Enable the release to be regenerated.
14* Consistency: codify naming, network locations, etc, for released components.
15* Ensure that the user base and public is notified of the release.
18== Steps to a Release ==
20The following steps to a release are documented in more detail below:
22* Create an svn branch to carry the release.
23* Prepare the code for release.
24* Tag the release.
25* Create release products: tarballs and dmgs.
26* Post release products.
27* Make release version available through selfupdate.
28* Notify public of the release.
31=== Create a Release Branch ===
33For each major release (i.e. 1.3.x, 1.4.x, etc.) an appropriate branch is created with a consistent name. To do this, two things are required:
35* Choose the svn revision from which to create the branch, most likely based off trunk.
36* Create the branch (e.g. release_1_4) through the svn "copy" command for history preservation, first creating the needed branch dir to preserve the needed directory structure (the 'base' directory level *needs* to exist int the branches tree for release branches, otherwise selfupdate breaks):
38 svn mkdir -m "commit-message"
39 svn cp -r<rev> -m "commit-message"
41The actual release, alpha or beta releases, release candidates, and any point releases will all live on this branch, and tagged appropriately and if necessary (a must for the actual releases, optional for beta snapshots) into the /tags svn directory.
43Only the base subdirectory, not the ports subdirectory, is branched for a given release.
46=== Prepare the code for Release ===
48In preparation for a release, several things should be completed within the code:
50* Update the file base/ChangeLog in both trunk and the relase branch to reflect the appropriate changes.
51* Update the file base/config/dp_version with the target release number. Note that this is a floating point number that corresponds to the release number; it should correspond roughly to the release number where possible. Release 1.4.1, for instance, would be represented by the floating point number 1.41. The version number in dp_version is displayed by the port command as the version of MacPorts, and is used by the selfupdate command to determine whether a newer version of code is available. This number should be different between trunk and a release branch and the former should be updated as needed to differentiate it from the latter.
52* Make sure that these, and any other changes or bug fixes are made on and/or merged between the release branch and trunk as needded. For instance, if you've made changes to ChangeLog only on the release branch, those changes should be merged back into trunk as well.
55=== Tag the Release ===
57Once the release is ready, it must be tagged so that the release components may be fetched in the future, to ensure replicatability.
59Generally, a release candidate is first tagged and built. When and if it is approved as the actual release, an additional tag is created that names the same sources.
61Tagging conventions:
63* release_1_4_0-rc1 (release candidate 1 for release 1.4.0)
64* release_1_4_0 (tagged release 1.4.0)
65* release_1_4_0-archive (tagged release 1.4.0 -- complete archive)
66* release_1_4_1 (1.4.1 release)
68We first tag the branched base directory to make up for the final release:
70 svn cp -m "commit-message"
72Although only the base subdirectory is branched and tagged for a given major release, we also create a seperate tag for the entire tree (base sources and full ports tree) at the time the final release tag is created (only for major releases, 1.x.0), in order to provide a stake in the ground that specifies a set of ports intended to work with that release. Note that this tag incorporates the entire svn trunk directory at the revision number at which the final release was tagged.
74The necessary working copy to create such a tag is created by checking out all of trunk at the specific revision of the final tagging of base and then switching the base directory inturn to the appropriate release tag URL. For instance:
76 svn co -r<rev> macports/release-1.4.0
77 cd macports/release-1.4.0/base
78 svn switch
80And finally we tag the entire directory as release_1_4_0-archive:
82 svn cp -m "commit-message" macports/release-1.4.0
85=== Create & Post Release Tarballs ===
87The release tarballs are tar.bz2 and tar.gz archives of the  base directory only and of the entire svn tree for a particular release. They are named with the following naming convention:
89 MacPorts-1.4.0.tar.{bz2,gz} (base directory only, corresponding to tag release_1_4_0)
90 MacPorts-1.4.0-archive.tar.{bz2,gz} (complete archives corresponding to tag release_1_4_0-archive)
92The following commands issued to the top level Makefile will generate the archives and checksums:
94 make DISTVER=1.4.0 distfromsvn
96Note that you need to pass the "ARC=yes" flag on the command line to the "distfromsvn" top-level make target if you also wish to produce the full archive tarballs.
98All these tarballs are uploaded via svn to the directory.
100Additionally, a file is created, and posted to the same location, that contains md5, sha1, and rmd160 checksums for each of the files:
102 MacPorts-1.4.0.chk.txt
103(We should have a way to sign these checksums, and have the signer's keys posted somewhere. Security experts in the project, would you be interested in leading this effort? Eric? Mark? Anyone else?)
106=== Create Release Disk Image(s) ===
108The dmg is a Mac OS X disk image that contains a standalone installer for major MacPorts releases (1.x.0), named in a consistent fashion and incorporating the OS version for which it was built.
110 MacPorts-1.4.0-10.3.dmg
111 MacPorts-1.4.0-10.4.dmg
113To create the disk image, use the macports port; the Portfile will need to be updated to incorporate the proper release version and the release tarballs will need to be already uploaded to the downloads section of the site (wherefrom the sources are fetched by the macports port to build the dmg for the release). Checksums need to be adapted likewise.
115 port dmg MacPorts
117Name the dmg appropriately, and generate checksums, which will need to be added to the checksum file:
119 cd work
120 mv MacPorts-1.4.0.dmg MacPorts-1.4.0-10.4.dmg
121 for type in -md5 -sha1 -ripemd160; do openssl dgst $type MacPorts-1.4.0-10.4.dmg; done
123These new products, along with the new checksums file, also have to be posted to the appropriate downloads directory of the MacPorts svn repository. Developers are required to validate the generated installer as thoroughly as possible through extensive testing (primarily done by inspecting the destroot of the MacPorts built port, validating library and executables linking, tclsh binary invoked by our scripts, etc.), which is mainly why this step of the release process is not automated through a Makefile or similar.
126=== Make the Release Available through Self-Update ===
128In order to make the release version available through selfupdate, the base/config/RELEASE_URL file in svn trunk needs to be updated with the tag of the release to distribute. This file is read by the cron job that makes the code available via rsync. See base/portmgr/mprsyncup. Though not strictly necessary, it's also good practice to update the same file accordingly in its branched guise.
131=== Notify the Public of the Release ===
133Once the release has been posted, notification of the release should be sent/posted to the following places:
135* The and mailing lists.
136* Apple's [ Mac OS X software downloads page] (submitter: jmpp@)
137* [ Freshmeat] (submitter: mww@)
138* [ VersionTracker] (submitter: mij@)
139* (Where else? -- MacUpdate?)
Note: See TracBrowser for help on using the repository browser.