/[cvs]/eggdev-docs/doc/RELEASE-HOWTO
ViewVC logotype

Annotation of /eggdev-docs/doc/RELEASE-HOWTO

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (hide annotations) (download)
Tue Nov 15 05:14:27 2005 UTC (13 years, 6 months ago) by wcc
Branch: MAIN
CVS Tags: HEAD
* A bit of modification to the directory structure.
* Added my little 'eggcheck' script to tools/. This is by no means anything
  complete, but it does find a few common errors that keep happening. Maybe
  something that we could improve and run from cron or at least before
  releases.

1 wcc 1.1 $Id: RELEASE-HOWTO,v 1.2 2005/10/15 23:56:50 wcc Exp $
2    
3     Developer Documentation: Release HOWTO
4     Last revised: October 15, 2005
5     _____________________________________________________________________
6    
7     Release HOWTO
8    
9    
10     1. Test compile (on a couple of different machines if possible) to make
11     sure everything is in order.
12    
13     2. Add the release date to doc/UPDATES1.6 and commit.
14    
15     3. Run the 'misc/releaseprep' script from the root directory. If this is an
16     RC release, run it as 'misc/releaseprep --rc 1', where 1 is the Release
17     Candidate number.
18    
19     This does the following:
20    
21     * Changes the default make from "debug" to "eggdrop".
22    
23     * Removes patches from patch.h (or, if this is an RC release,
24     it will modify patch.h to indicate a Release Candidate).
25    
26     * Removes 'CVS' directories and '.cvsignore' files.
27    
28     * Remove the empty doc/web_docs and doc/html/chat directories.
29    
30     * Runs 'make distclean'.
31    
32     * Creates a default Makefile which instructs the user to run
33     ./configure before typing 'make'.
34    
35     * Prints out the current patch. If this is an RC release, it
36     should say "RC1", "RC2", etc. If this is a final release, this
37     should say "(could not detect)".
38    
39     NOTE: After running this script, you will not be able to commit, as the
40     'CVS' directories have been removed.
41    
42     4. 'cd ..' and then rename the 'eggdrop1.6' CVS directory to 'eggdrop1.6.x'
43     (for example, eggdrop1.6.18).
44    
45     5. Download and extract a copy of the previous release. If this is an RC1
46     release, this should be the previous final release of Eggdrop. If this
47     is RC2 or later, you should download both the previous Release Candidate
48     and the previous final release.
49    
50     6. Create a diff from the previous version to the version about to be
51     released. For 1.6.18, this would be:
52    
53     diff -urN eggdrop1.6.17/ eggdrop1.6.18/ > eggdrop1.6.17-1.6.18.diff
54    
55     For 1.6.18RC1, this would be:
56    
57     diff -urN eggdrop1.6.17/ eggdrop1.6.18/ > eggdrop1.6.17-1.6.18RC1.diff
58    
59     For 1.6.18RC2, this would be:
60    
61     diff -urN eggdrop1.6.17/ eggdrop1.6.18/ > eggdrop1.6.17-1.6.18RC2.diff
62     diff -urN eggdrop1.6.18RC1/ eggdrop1.6.18/ > eggdrop1.6.18RC1-1.6.18RC2.diff
63    
64     7. Create the archives. You need to create a tar/gzip -9 and a tar/bzip2 -9
65     archive of the eggdrop1.6.##/ directory and a gzip -9 of the diff(s). To
66     speed things up, create the bzip2 archive first, using bzip2 -9 -k, and
67     THEN create the gzip archive. The bzip2 -k option makes bzip2 keep the
68     input file, instead of deleting it.
69    
70     8. If you are not the one who will be releasing Eggdrop to the Eggheads FTP
71     mirrors:
72    
73     * Move the archive files into a directory of their own (such as
74     "eggrelease/"), and then do a "md5sum *".
75     * Send the archives, along with a copy of the MD5sums, to the person
76     who will be releasing to the mirrors.
77    
78     9. Before releasing Eggdrop to the Eggheads FTP mirrors, the MD5sums for all
79     of the files should be verified. After verifing the MD5sums, it's time
80     to sign the archives. Each file needs to have a matching .sig (or .asc).
81     After signing, do an md5sum of all the release files (including the
82     .sig's). This will be needed for the release e-mail.
83    
84     10. Extract one of the tarballs and give it a final test-compile.
85    
86     11. Now it's time to release Eggdrop to the FTP Mirrors.
87    
88     12. Write a release e-mail. It should include:
89    
90     * A download link.
91     * A summery of major changes between this release and the last one.
92     * MD5 sums.
93     * A link to the public key which can be used to verify the sigs.
94     * Any notes that you feel should be added.
95    
96     13. Send the e-mail to eggdev@eggheads.org.
97    
98     14. Announce the release on http://www.eggheads.org/, and then send the release
99     e-mail to eggheads@eggheads.org, as well as alt.irc.bots.eggdrop, and
100     #eggdrop on Undernet.
101    
102     15. If this is a final release, the following need to be updated:
103    
104     * http://www.eggheads.org/downloads/
105     * www.geteggdrop.com
106     * SourceForge
107     * FreshMeat
108     * Web Docs
109     * Bugzilla (change "1.6.XX CVS" to "1.6.XX")
110    
111     16. Celebrate! =P
112    
113     17. When starting the next version in CVS:
114    
115     * Update bugzilla. Add the new CVS version to products, and close any
116     resolved bugs from the past version.
117    
118     * Run the 'misc/newversion' script. This will update all of the
119     version numbers throughout the tree to start a new version. Check the
120     CVS diff to verify, and then commit. Then run 'misc/runautotools' to
121     regenerate the configure scripts, and commit again.
122    
123     _____________________________________________________________________
124    
125     Copyright (C) 2004 - 2005 Eggheads Development Team

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23