Release Instructions ^

To prepare a release:

0.

Announce to parrot-porters and #parrot at least a couple days in advance, asking if there are any showstopping bugs. It's also good to ask for updates to NEWS, CREDITS, PLATFORMS, RESPONSIBLE_PARTIES, etc. You might also select a name for your release (e.g., perhaps select a name from http://en.wikipedia.org/wiki/List_of_parrots).

1.

Make sure you're up to date:

 $ svn update
You may want to ask the developer base to stop committing big changes; it will avoid complications. Or you could create a release branch before releasing, rather than after. Then you could fold the release-oriented changes into the trunk once the release is done.

TODO: explain how to do this

2.

Update files with version-specific information:

a

Increment the version number in the following files: VERSION, parrot.spec, MANIFEST.generated, META.yml, README.

Also update the version number, date, and your name in the following files: DEVELOPING, docs/parrothist.pod, and docs/ROADMAP.pod

Also update the URL in parrot.spec for "Source0" to point to the current release manager's CPAN directory. [Really, we should provide a more standard location for the release tarball.]

b

Update ChangeLog, NEWS with the new version number and any other changes that have occurred since the last release: Hopefully these files are being updated as committers work.

c

Update release-related information in tools/util/release.json. This will be used later when making release announcements. There are a few interesting fields:

rt.tracking

Create a new ticket for the next release. Change the URL fragment here to use that ticket's number.

rt.saved_search

Open the link to the previous value of this field. Copy the resulting full URL, then change the ticket number in the DependedOnBy parameter to the ticket for the next release. Take the entire resulting URL to http://xrl.us/ and get a short URL. Add that to this field.

d

Make sure RESPONSIBLE_PARTIES is still accurate.

e

Configure parrot and run perl t/harness t/distro/*.t, and either fix what those tests complain about, or fix them so they don't complain.

f

Update PBC_COMPAT, perhaps by collapsing intra-release entries into a single entry naming the release.

g

Run perl tools/dev/pbc_header.pl --upd t/native_pbc/*.pbc to update version and fingerprint in the native tests.

h

Make sure everything works:

 $ make realclean
 $ perl Configure.pl --test ...
 $ make -s all world fulltest html
 # Note that fulltest runs separate harnesses..
3.

 svn commit
4.

Prepare the release tarball.

 $ make release VERSION=a.b.c
where a.b.c is the version number. This will create the tarball named parrot-a.b.c.tar.gz. This will automatically avoid including DEVELOPING in the release tarball.

5.

Untar parrot-a.b.c.tar.gz into another area.

6.

Make sure everything works:

 $ perl Configure.pl
 $ make world
 $ make fulltest
 $ make docs
 $ make html
7.

Tag the release as "RELEASE_a_b_c", where a.b.c is the version number. If you're working in trunk, be sure to specify the revision number generated in step 3, above.

 $ export SVNPARROT=https://svn.perl.org/parrot
 $ svn copy -m"tagged release a.b.c" \
   $SVNPARROT/trunk $SVNPARROT/tags/RELEASE_a_b_c
See also "Appendix 1" below.

8.

In PAUSE, assign yourself co-maintainter permissions on all modules owned by PARROTRE.

Upload to CPAN.

NOTE: you may get a failure message from the CPAN Indexer about the content of META.yml. Don't panic, the tarball still uploaded okay. You do need to fix META.yml for the next release. Under "no_index" list any modules that aren't properly part of the Parrot distribution.

Once you get a reply from the PAUSE indexer, log in to PAUSE to clean up module permissions. Under "View Permissions" search for your PAUSE ID. Any new modules added in this release will list your PAUSE ID as the "owner". Change the owner to PARROTRE.

See docs/project/pause_guide.pod for more details.

9.

Compose and send out the announcements -- parrot-porters, perl6-language, perl6-announce, perl5-porters, use Perl, PerlMonks, etc. Don't forget to include the next scheduled release date.

Use tools/util/crow.pir to make this part easier. You can specify the format of your announcments like so:

  $ parrot tools/util/crow.pir --type=text
  $ parrot tools/util/crow.pir --type=html
Take the screen output and paste it into the application you need. HTML works well for use Perl and PerlMonks, and text for the rest.

a

Submit the use Perl announcement story to Slashdot, Newsforge, etc. Don't forget to set a Reply-To: or Followup-To: header, if your mail client lets you.

b

Modify the topic on #parrot, e.g.:

 /topic #parrot Parrot 0.4.8 Released | http://parrotcode.org/
c

Update the next planned release date on the wiki.

d

Update the website. The svn repository for the website is at https://svn.perl.org/perl.org/docs/live/parrotcode.

Add a release announcement to news/[year]/Parrot-[release].html. Update /index.html (The old mini-announcement may be commented out). Update /source.html. Make sure all urls are updated appropriately.

Test locally in combust before pushing update out.

10.

Close any release-related tickets in RT. If they are not yet resolved, migrate the critical ones to the next milestone release ticket. Non-critical unresolved tickets can be simply unlinked.

11.

You're done! Help yourself to a beer, cola or other celebratory drink.

ABOUT THIS DOCUMENT ^

This document was written after a couple of subtly incorrectly assembled releases--usually when someone forgot to delete DEVELOPING (which is now automated!), but at least once where the MANIFEST check failed. The intent of this file is to document what must be done to release so that such mistakes don't happen again.

SEE ALSO ^

README, RESPONSIBLE_PARTIES.

Appendix 1 ^

parrot repository layout as of end of Apr 2005

 $ svn ls $SVNPARROT
 branches/
 tags/
 trunk/

 $ svn ls $SVNPARROT/tags
 PRE_REL_0_0_8/
 RELEASE_0_0_10/
 RELEASE_0_0_11/
 RELEASE_0_0_13/
 RELEASE_0_0_6/
 RELEASE_0_0_8/
 RELEASE_0_0_9/
 RELEASE_0_1_0/
 RELEASE_0_1_1/
 RELEASE_0_1_2/
 REL_0_0_5/
 V1/
 file_move_031023/
 help/
 ponie-PRE-P5_592/

Appendix 2 ^

Planned releases in 2007.

To make a monthly release schedule possible, we're spreading the burden of releases across multiple release managers. Each release manager takes one release in a 6 month rotation. Releases are scheduled for the 3rd Tuesday of the month.

 - Jan 16th (0.4.8)  Jerry Gay (particle)
 - Feb 20th (0.4.9)  Patrick Michaud (pmichaud)
 - Mar 20th (0.4.10) Will Coleda (Coke)
 - Apr 17th (0.4.11) Matt Diephouse (mdiep)
 - May 15th (0.4.12) chromatic
 - Jun 19th (0.4.13) Allison Randal
 - Jul 17th (0.4.14) Jerry Gay (particle)
 - Aug 21st (0.4.15) Patrick Michaud (pmichaud)
 - Sep 18th, Matt Diephouse (mdiep)
 - Oct 16th, Will Coleda (Coke)
 - Nov 20th, chromatic
 - Dec 18th, Allison Randal


 parrot