wiki:Release

Version 31 (modified by waxhead, 3 years ago) (diff)

--

Release

Once Padre or one of the plugins is released based on the following process it is uploaded to CPAN. There are various way Repackaging and Distributing those modules.

Prerequisites to releasing Padre

As the Release Manager you will be uploading the Padre tarball to pause, to ensure you have the right permissions to do this you must obtain co-maintenance permissions for all of the namespaces in the Padre distribution. Talk to Gábor Szabó (szabgab), Adam Kennedy (Alias), or Steffen Müller (tsee) about this. Make sure you get Wx::Perl::Dialog, Wx::Perl::Dialog::Frame, Wx::Perl::Dialog::Simple, and Wx::Perl::Dialog::SingleChoice? too.

Release of Padre using a branch

In order to allow a few days of stabilization of Padre and to allow the translators to catch up while allowing everyone else to freely work on the main trunk we release from a branch.

A few (2 or 3) days before the planned release date the release manager creates an svn copy of trunk to branches/release-n.nn.

The high level steps are as follows:

  • Make sure all tests pass,
  • Set the release version, commit,
  • Tidy the project, commit,
  • Update Changes file, commit,
  • Rebuild the messages.pot, commit, no longer required
  • Set the version from current dev to next production release, commit,
  • Branch
  • Announce branch and URL to dev list,
  • Allow a few days for translators,
  • Build Tar Ball,
  • Test where you can.
  • Upload to PAUSE.
  • Prior to merge back, set version to current dev version ( should be +1 ), commit,
  • Merge changes on Branch back to Trunk, this should only be the translations if all went well.

Detailed Steps for a Release

Note: All commands are taken as relative to your Padre directory ( the one with Makefile.PL in it )

  • run perltidy on the trunk ../tools/tidy_project.pl
  • commit
  • Update the Changes file, noting the date of the release being the date you start the branch
  • commit
  • set the version from the current development version number to the release version number ( should be even numbered for released odd numbers for development )
    • Note: there is a script in tools that will update the $VERSION string, however PPI::PowerToys? has an awesome ppi_version, use this when you can: ppi_version change old_ver new_ver, ie ppi_version change 0.81 0.82
  • commit
  • rebuild the "messages.pot" file, run ../tools/update_pot_file.pl
  • commit

At this point trunk is ready for you to make the branch:

  • svn cp http://svn.perlide.org/padre/trunk/Padre http://svn.perlide.org/padre/branches/release-X.XX (replace X.XX with the future version number)

You have now created the release branch for Padre.

To complete the final tasks on trunk, update the Changes file by "opening" the next version.

  • Modify Changes, set the next development version number, this should be odd and the next release version number should be even, ie if you have just branched release-0.82, then changes gets updated with:

0.84 TBA

0.83 Dev - not released.

From this point onwards you switch your working copy between the branch and trunk as needed. To switch between trunk and the branch:

  • svn switch http://svn.perlide.org/padre/branches/release-X.XX .
  • then every commit will go to the branch while the plugins are still from trunk
  • the release can be done here but probably it is better NOT to run the perl tidy on the branch as it will make merging very difficult

Announce the Branch in padre-dev =

Announce the branch in the dev mailing list and put out a call for translators, an email template is provided:

Hi Team,

I have just made a branch of trunk for the next Padre release <version>.

Could all translators be so kind as to update their language.

To do so, either check out a working copy of the branch here:

svn co http://svn.perlide.org/padre/branches/Padre-<version>

or alternately you can switch your working copy:

svn switch http://svn.perlide.org/padre/branches/Padre-<version>

Please commit all changes to the branch for inclusion into the next great release of Padre.

Regards,

<name> Padre Release Manager.

Do the regular release process

  • The release manager first builds a distribution and when she is sure it creates a good release, she can run the release.pl script again to also tag the release in SVN and then ask others to test it:
    • the environment variable RELEASE_TESTING should be set to ensure testing for a release is run.
    • the release.pl script will set it if the variable isn't found. If you want more control over the testing before a release set RELEASE_TESTING to 1 to test, 0 to turn testing off.
    • run perl ../tools/release.pl --revision REV --version VERSION will try to create a distribution using a temporary directory and copy the resulting Padre-X.XX.tar.gz in the current directory.
    • Test it by yourself (install it using pip, run it)
    • run perl ../tools/release.pl --revision REV --version VERSION --tag This will also create a tag in SVN.
    • Upload it somewhere public and ask Gabor to copy to http://perlide.org/download/source/
    • Tell people on IRC #padre about it and ask them to test it
  • Upload to PAUSE
  • Send announcement to padre-dev mailing list
  • Send announcement to padre-news mailing list (Gabor might need to send the message but at leas he needs to approve it after you sent it)
  • Submit announcement to http://use.perl.org/ or some other well-read blog (e.g. one that is syndicated on Iron Man and on http://blogs.padre.perlide.org/ )
  • Update the Release History
  • Add the version number to the list of versions in Trac. A trac admin needs to do this:
    • Go to Admin/Versions? in the "Name:" box type in the version number eg. 0.45, click on "Add"
    • Select the radio box on the right hand side of the newly added line and click on "Apply changes"
  • Important: Assign primary maintainer status to Gabor (PAUSE ID 'SZABGAB') for all namespaces that are new in the current release.
    • Log into your PAUSE account
    • Click "View Permissions" in the menu
    • Note all Padre::* classes for which you are listed as "first-come" (as opposed to "co-maint").
    • Click "Change Permissions" in the menu
    • Under "2. You are primary maintainer:" select any one or all of the Padre::* namespaces that appear in the list view.
    • Click Select for "2.1 Pass primary maintainership status to somebody else (giving it up at the same time)"
    • Make sure all Padre::* namespaces are selected in the new listbox.
    • Enter "SZABGAB" in the text field.
    • Click "Pass Maintainership Status".
    • You will automatically become co-maintainer instead of primary maintainer of the classes in question.
  • ppm creation:
  • Create executable for Linux:

Merging back to trunk

  • when finished merge the branch back to trunk:
  • svn switch http://svn.perlide.org/padre/trunk/Padre .
  • svn log --stop-on-copy http://svn.perlide.org/padre/branches/Padre-X.XX
  • Take the FIRST and LAST revision number from that log
  • svn merge -rFIRST:LAST http://svn.perlide.org/padre/branches/Padre-X.XX/ .
  • If you do not get any merge conflicts, then follow the next step, otherwise use "Resolving Merge Conflicts" as a quick guide to help resolve any conflicts.
  • svn commit -m'merge -rFIRST:LAST http://svn.perlide.org/padre/branches/Padre-X.XX/'
  • now you can remove the release branch:
  • svn rm http://svn.perlide.org/padre/branches/Padre-X.XX/

Resolving Merge Conflicts

If you are fortunate you will not see merge conflicts when you merge the branch back to trunk, however if you do, then the following is a quick crib on how to deal with it.

When svn updating you SVN will halt at the file in conflict asking you what to do, simply select "postpone" as we will go back to the conflicted file(s) after the merge has completed.

SVN will create three files if there is a merge conflict in trunk and the branch, a 'left.merge', 'working' and 'right.merge' file.

The simple way to work this out, is open the actual file in vim.

Look for lines that begin with >>> or <<<

Depending on which lines you keep, remove the lines between >>> or <<< and === and remove these lines too.

Once you have completed the merge and are happy with the changes, tell svn you have resolved the problem:

svn resolved <file-name>

This removes the merge conflict files.

Once you have completed all the conflicts, return back to the parent directory and svn commit with a message like 'merge -rFIRST:LAST http://svn.perlide.org/padre/branches/Padre-X.XX/' as this shows up in the log where you merged the branch back.

Release of Plugins and other packages

The packages can use either Makefile.PL (Module::Install) or Build.PL (Module::Build). We have not tested the below process with ExtUtils::Makemaker

No need to keep MANIFEST and META.yml in version control!

Add to MANIFEST.SKIP

# avoid pot files (gettext)
\.pot$

If you are using Module::Build

Don't add a Makefile.PL to the version control as it will be created during packaging

Release process

  • cd to the directory of the plugin or the package
  • ../tools/
  • run perl ../tools/tidy_project.pl (commit)
  • run perl ../tools/update_version_number.pl VERSION and update Changes (commit)
  • run perl ../tools/release.pl REV VERSION [--tag]
  • upload to PAUSE

Release Manager

The current release manager is Peter Lavender (waxhead on IRC).

Release schedule

The exact release schedule is decided by the current release manager, below are the general guidelines

Padre is released to CPAN about once every week when trunk seems to be in a stable state.

Once a month we set aside a version for a "packaged" release for which we use a longer time on the release branch.

We take the latest regular release and base the "packaged" release right on the regular release. So for example we have 0.43, 0.44, regular releases then based on 0.44 we create a release branch for 0.45 We give the translators a few days to catch up on this branch. That time will also allow people to give feedback on 0.44 so we can fix really critical issues on the 0.45 branch.

This release should be scheduled just a few days after Rakudo is released.

Once it is done CSJewell creates the windows distributions based on Strawberry Perl.

That means we have these "packaged" and translated releases by ~ 20-25th of every month.

See this post http://mail.perlide.org/pipermail/padre-dev/2009-August/001203.html and create a better tuned process for the "packaged" releases.

Pre-Release Tests (proposal)