Versions Compared

Old Version 25

changes.mady.by.user Josh Thompson

Saved on

compared with

New Version 26

changes.mady.by.user Josh Thompson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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.
    • Make sure copyright date is correct in NOTICE file
  • Files containing the VCL version should be updated to the version being released
    • The backend Perl files contain a line defining a $VERSION variable, this should be updated in every file
  • 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
  • make sure INSTALLATION file is up to date with content from Confluence on how to install each part
  • ensure LICENSE, NOTICE, RELEASE_NOTES, CHANGELOG, INSTALLATION, UPGRADE, 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
  • make sure the index.php file from the web code has the correct VCL version at the top of it

Steps to create a release candidate artifact

...

  • 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)
  • Set the newly released version to the Release status in JIRA so that people will be able to see it as released when reporting bugs
    • Go to the JIRA site
    • click Manage under the Versions section
    • In the Operations column, click the Release link for the specified version
  • Add a news entry to our Incubator Project page
    • ssh to people.apache.org
    • check out the incubator site
    • svn co https://svn.apache.org/repos/asf/incubator/public/trunk/Image Removed incubator_site
    • edit site-author/projects/vcl.xml and add a news entry about the release
    • Regenerate the vcl.html file by running 'ant' or 'build' from the the incubator_site directory
    • svn commit your changes
    • cd /www/incubator.apache.org
    • svn update

...