Bring CHANGES up to date.
[cvs2svn.git] / doc / making-releases.txt
blob3df9dc1414ed0ba55b8f302c27fe46faf4129e1d
1 Making releases
2 ===============
4  Pre-release (repeat as appropriate):
5    A. Backport changes if appropriate.
6    B. Update CHANGES.
7    C. Run the testsuite, check everything is OK.
8    D. Trial-run ./dist.sh, check the output is sane.
9    E. Run "www/validate.sh www/*.html" to make sure that the
10       documentation HTML is valid.
12  Creating the release:
13    1. If this is an A.B.0 release, make a branch:
14         svn copy http://cvs2svn.tigris.org/svn/cvs2svn/trunk \
15           http://cvs2svn.tigris.org/svn/cvs2svn/branches/A.B.x
16       and then increment the -dev VERSION in cvs2svn_lib/version.py on
17       trunk.
18    2. Set the release number and date in CHANGES on trunk.
19    3. Switch to a branch working copy.
20    4. Merge CHANGES to the release branch.
21    5. Make a trial distribution and see that the unit tests run:
22         ./dist.sh
23         tar -xzf cvs2svn-A.B.C-dev.tar.gz
24         cd cvs2svn-A.B.C-dev
25         ./run-tests.py
26         cd ..
27         rm -rf cvs2svn-A.B.C-dev
28    6. Set VERSION in cvs2svn_lib/version.py and then run:
29         svn copy . http://cvs2svn.tigris.org/svn/cvs2svn/tags/A.B.C
30    7. Increment the -dev VERSION in cvs2svn_lib/version.py on the
31       A.B.x branch.
32    8. Switch to the tag.
33    9. Run:
34         ./dist.sh
35   10. Create a detached signature for the tar file:
36         gpg --detach-sign -a cvs2svn-A.B.C.tar.gz
38  Publishing the release:
39    1. Upload tarball and signature to website download area (log in,
40       go to "Downloads", then "Releases" folder, then "Add new file").
41    2. Move old releases into the 'Old' folder of the download area
42       (click on the "Edit" link next to the files, then change
43       Status -> "Archival" and Folder -> "Old").
44    3. Create a project announcement on the website.  See example
45       template below.
46    4. Send an announcement to announce@cvs2svn.tigris.org.
47       (users@cvs2svn.tigris.org is subscribed to announce, so there is
48       no need to send to both lists.)  See example template below.
49    5. Update the topic on #cvs2svn.
51  Publishing the release to PyPI (http://pypi.python.org):
52    1. Unpack the release tarball.
53    2. Run
54         python setup.py register
55       Within PyPI, cvs2svn appears here: http://pypi.python.org/pypi/cvs2svn
58 Release announcement templates
59 ==============================
61 Here are suggested release announcement templates.  Fill in the substitutions
62 as appropriate, and refer to previous announcements for examples.
64 Web:
65 [[[
66 cvs2svn VERSION is now released.
67 <br />
68 The MD5 checksum is CHECKSUM
69 <br />
70 For more information see <a
71 href="http://cvs2svn.tigris.org/source/browse/cvs2svn/tags/VERSION/CHANGES?view=markup"
72 >CHANGES</a>.
73 <br />
74 Download: <a
75 href="http://cvs2svn.tigris.org/files/documents/1462/NNNNN/cvs2svn-VERSION.tar.gz"
76 >cvs2svn-VERSION.tar.gz</a>.
77 ]]]
79 Email:
80 [[[
81 Subject: cvs2svn VERSION released
82 To: announce@cvs2svn.tigris.org, git@vger.kernel.org
83 Reply-to: users@cvs2svn.tigris.org
85 cvs2svn VERSION is now released.
87 BRIEF_SUMMARY_OF_VERSION_HIGHLIGHTS
89 For more information see:
90 http://cvs2svn.tigris.org/source/browse/cvs2svn/tags/VERSION/CHANGES?view=markup
92 You can get it here:
93 http://cvs2svn.tigris.org/files/documents/1462/NNNNN/cvs2svn-VERSION.tar.gz
95 The MD5 checksum is CHECKSUM.
97 Please send any bug reports and comments to users@cvs2svn.tigris.org.
99 YOUR_NAME, on behalf of the cvs2svn development team.