1 How to do a masqmail release

2 ============================

3 meillo 2010-12-09

4

5

6 This document helps me to not forget any steps and to document how I

7 did it for any new maintainer who might come after me. This document

8 was inspired by docs/README.developers of the nmh project.

9

10

11 (1) Be sure that the current state of the project is ready to

12 release. Test if it compiles. Test if it works (this should be done

13 automatically with a better test suite).

14

15 (2) Update ChangeLog and NEWS based on the VCS log. Don't forget to

16 update the time of the ChangeLog entry. Check if contributions from

17 others are acknowledged adequately (ChangeLog, THANKS).

18

19 (3) Remove the -dev suffix from the version number in configure.ac. Run

20 autoconf afterwards to transfer the change to the configure script. Build

21 masqmail and run it with -bV to check the version.

22

23 (4) Run devel/list-versions and devel/update-manpage-date afterwards to

24 have the right version and date in the man pages.

25

26 (5) Is everything checked in?

27

28 (6) Run `make distclean', check for remaining files (just in case). `hg

29 st' is helpful. Build anew: `./configure ... && make && sudo make

30 install'. Check if everything went well. If so, `make distclean' again.

31

32

33 Now we should be ready to release.

34

35

36 (7) Run `devel/gen-release ../masqmail-0.x.y.tar.gz'. An md5sum will

37 be generated automatically and a detached gpg signature will be created

38 (this requires gnupg with a secret key).

39

40 (8) Unpack the generated tarball and examine its contents (-t or

41 -xv). Build masqmail anew from the tarball, see (6).

42

43 (9) Check the md5sum and the signature.

44

45

46 Let's release.

47

48

49 (10) Upload the tarball, the md5sum and the signature to the website.

50

51 (11) Write a release announcement to the mailing list. Preferably, the

52 announcement should contain the MD5 hash generated above, and should be

53 PGP-signed. It should include the URL for the tarball as well as the URL

54 of the website. It should contain a brief summary of visible changes, as

55 well as the URL of the webpage that would show a detailed list of changes.

56

57 (12) Submit a release info to freshmeat.net.

58

59 (13) Add a version tag to the VCS.

60

61 (14) Change the version number in configure.ac: Increment it and add

62 -dev to it. Run autoconf afterwards to propagate the change.

63

64

65 Done.

66

67

68 Enjoy the day. :-)