RELEASE_INSTRUCTIONS

   1 # $Id$
   2
   3 To prepare a release:
   4
   5     0.  Announce to parrot-porters and #parrot at least a couple days in
   6         advance, asking if there are any showstopping bugs.
   7
   8     1.  Make sure you're up to date:
   9
  10           $ svn update
  11
  12         You may want to ask the developer base to stop committing big
  13         changes; it will avoid complications.  Or you could create a release
  14         branch before releasing, rather than after.  Then you could fold the
  15         release-oriented changes into the trunk once the release is done.
  16         {{ TODO: explain how to do this }}
  17
  18     2.  Update files with version-specific information:
  19
  20         a.  Increment the version number in:
  21             - VERSION
  22             - parrot.spec,
  23             - compilers/imcc/main.c
  24             - MANIFEST.generated
  25             - META.yml
  26
  27         b.  Change the information in DEVELOPING to reflect this release's
  28             version number and date.
  29
  30         c.  Update README.
  31
  32         d.  Update ChangeLog, NEWS, docs/ROADMAP.pod, and docs/BROKEN.pod.
  33
  34         e.  Make sure RESPONSIBLE_PARTIES is still accurate.
  35
  36         f.  Run "perl t/harness t/distro/*.t", and either fix what those tests
  37             complain about, or fix them so they don't complain.
  38
  39         g.  Update PBC_COMPAT, perhaps by collapsing intra-release entries
  40             into a single entry naming the release.
  41
  42         h.  Run C<perl tools/dev/pbc_header.pl --upd t/native_pbc/*.pbc>
  43             to update version and fingerprint in the native tests.
  44
  45         i.  Make sure everything works:
  46
  47               $ make realclean
  48               $ perl Configure.pl ...
  49               $ make -s all world fulltest
  50
  51     3.  svn commit
  52
  53     4.  Make the release tarball:
  54
  55           $ make release VERSION=a.b.c
  56
  57         ... where a.b.c is the version number.  This will create the tarball,
  58         named parrot-a.b.c.tar.gz.
  59
  60     5.  Untar parrot-a.b.c.tar.gz into another area
  61
  62     6.  Make sure everything works:
  63
  64           $ perl Configure.pl
  65           $ make world
  66           $ make fulltest
  67
  68     7.  Tag the release as "RELEASE_a_b_c", where a.b.c is the version
  69         number.
  70
  71           $ export SVNPARROT=https://svn.perl.org/parrot
  72           $ svn copy -m"tagged release a.b.c \
  73             "$SVNPARROT/trunk $SVNPARROT/tags/RELEASE_a_b_c
  74
  75         See also below [1]
  76
  77     8.  Upload to CPAN.
  78
  79     9.  Compose and send out the announcements -- parrot-porters,
  80         perl6-language, perl6-announce, perl5-porters, use Perl, PerlMonks,
  81         comp.lang.perl.misc, etc.
  82
  83     9a. Submit the use Perl announcement story to Slashdot, Newsforge, etc.
  84
  85         Don't forget to set a Reply-To: or Followup-To: header.
  86
  87     10. You're done!  Help yourself to a beer, cola or other celebratory
  88         drink.
  89
  90 ABOUT THIS DOCUMENT:
  91
  92 This document was written after a couple of subtly incorrectly assembled
  93 releases--usually when someone forgot to delete DEVELOPING, but at least
  94 once where the MANIFEST check failed.  The intent of this file is to
  95 document what must be done to release so that such mistakes don't happen
  96 again.
  97
  98 --------------
  99
 100 Appendix [1] parrot repository layout as of end of Apr 2005:
 101
 102 $ svn ls $SVNPARROT
 103 branches/
 104 tags/
 105 trunk/
 106
 107 $ svn ls $SVNPARROT/tags
 108 PRE_REL_0_0_8/
 109 RELEASE_0_0_10/
 110 RELEASE_0_0_11/
 111 RELEASE_0_0_13/
 112 RELEASE_0_0_6/
 113 RELEASE_0_0_8/
 114 RELEASE_0_0_9/
 115 RELEASE_0_1_0/
 116 RELEASE_0_1_1/
 117 RELEASE_0_1_2/
 118 REL_0_0_5/
 119 V1/
 120 file_move_031023/
 121 help/
 122 ponie-PRE-P5_592/