You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Prerequisites: Things that must be done before a release

  • all items from the JIRA roadmap for the release must be completed or moved to a future release
  • ALL human readable files must contain the Apache license header
    • this includes style sheets, test code, and documentation - when in doubt, add a header
    • files that are part of other software packages that are bundled with a release must not contain the header (unless that software is also ASF software) and should be clearly documented as being bundled software
  • LICENSE and NOTICE files should be reviewed
    • LICENSE: This file should have the Apache License at the top of it; any third party artifacts or documents included in the release should have their licenses included in this file along with a clear explanation of which files each license applies to.
    • NOTICE: This file is for additional copyright and attribution statements any third party licenses may require. A typical NOTICE document at a minimum includes a copyright and attribution statement for The Apache Software Foundation. Nothing else belongs in the NOTICE document.
  • documentation on how to upgrade from a previous release must be created
    • if appropriate, scripts to help users upgrade should be created (don't forget steps/scripts to upgrade the database schema)
  • RELEASE_NOTES file needs to be updated and should contain:
    • release version
    • an intro to VCL
    • a brief description of the aims of VCL
    • a brief roadmap of VCL and how this release fits in to it
    • a list of ways for users to get involved
    • a description of how users can submit issues
  • the following disclaimer in a README file:
    Apache VCL is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
  • the README file must also contain all dependencies (this includes PHP, Perl, MySQL versions in addition to perl and php modules, dojo, etc.) for running VCL, any changes in dependencies since the last release must be listed in the CHANGLOG file
  • generate a CHANGELOG file
    • go to the JIRA site
    • click Release Notes
    • select the release version
    • select text as the style
    • scroll down to Edit/Copy Release Notes
    • copy/paste the contents to a new section in the CHANGELOG file
    • make sure to add any changes in the dependencies since the last release
  • ensure LICENSE, NOTICE, RELEASE_NOTES, CHANGELOG, and README files are in top level directory of trunk (or the branch that will be used for the release)
  • an export from HEAD should result in a directory tree with all files and directories having appropriate permissions
  • release manager's GPG signing key must be in KEYS file in toplevel directory of SVN (one above trunk)
  • a release/download page needs to be created for the specific release containing:
    • link to release artifact (link to a mirror)
    • link to signatures and checksums (link directly to apache.org)
    • steps explaining how to verify artifact using signatures and checksums
    • either a link to release notes or contain them inline
    • either a link to a change log or contain it inline
  • a decision needs to be made determining which, if any, previously released artifacts should be removed from the main distribution site after this release is completed

Steps to create a release candidate artifact

  • A tag for the release candidate needs to be created in subversion. It should be created under the tags directory of the repository and should be named release-W.X.Y-RCZ (with Z being the release candidate number, starting with 1 and with .Y only being included if Y > 0)
  • export from this tag to get the code for the release candidate
  • create a tarball of the directory
    • compress it with bzip2
    • name it apache-VCL-W.X.Y-RCZ-incubating.tar.bz2 (the .Y should only be included if Y > 0)
  • create MD5 and SHA-1 sums of the tarball
  • sign the tarball with GPG
  • distribute the RC through the release manager's personal web space on people.apache.org (RC are not to be release from the main distribution area to cut down on archive storage and mirroring bandwidth)

Community and PMC voting process

NOTICE: these steps may not be completely correct

  • release manager should start a VOTE thread on the vcl-dev list; this is a good example
  • after a passing vote (must have at least three +1 votes, majority of votes must be positive), the release manager should post a message to the general at incubator.apache.org list formally requesting approval for the release and containing:
    • Links to the release artifacts
    • Links to the PPMC release vote thread
    • Link to the tag from which the release is cut
    • this is a good example
  • there must be at least three +1 Incubator PMC votes to pass

Steps to make the RC available as a release artifact

  • create a tag for the release from the approved RC tag
  • create a copy of the approved RC artifact and name it apache-VCL-X.Y.Z-incubating.tar.bz2 (the .Z should only be included if Z > 0)
  • sign the file with GPG

Steps to make release artifact available to users

  • place the release artifact in /www/www.apache.org/dist/incubator/vcl on people.apache.org
  • ensure the artifact has permissions 664 and is owned by the incubator group
  • wait 24 hours for the artifact to propagate to the mirrors before announcing the release
    • ideally, a test download should be done from the mirror and a check of the sums and signatures should be done
  • After successfully performing a test download from the mirror, announcements should be made
    • on the vcl-dev@ list
    • on the vcl-user@ list
    • update currently listed version and download link on confluence Index page
    • (update this list as the community grows)

IMPORTANT: Once a release is copied to the dist location, it must not be modified. This can signal that an attack is being performed. If an error is found, a new .Z release should be made.

  • No labels