Release Checklist

This checklist describes the release process of a component assuming it has a version in the format X.Y[.Z].

1. Check merges on the release branch
2. Build Linux/OSX/Windows
   1. Check Dependencies
   2. Check Source
      1. Module header comments
      2. Module CVS tagline
      3. Module public API comments
      4. _COPYRIGHT Attribute
      5. _DESCRIPTION Attribute
      6. _VERSION Attribute using the format projectname X.Y.Z
   3. Check documentation
      1. Documentation Format
      2. Module name
      3. Version
      4. License
      5. What's new
         1. Include the CVS delta based on the sum of resource histories (compare with the previous tag)
      6. Release date
      7. References to LuaBinaries
         1. Index and manual pages
         2. LuaBinaries version
      8. Images (PNG, GIF)
      9. Module Dependencies
         1. Dependencies names, sites and versions used with this module version
      10. Documentation Links
          1. Links to previous versions. This may require the creation of a directory on the Kepler site and the copy of the previous files to the directory corresponding to (http://www.keplerproject.org/projectname/X.Y)
          2. Download from LuaForge (http://luaforge.net/projects/projectname/files)
          3. Links to Kepler Project Home (including the logos)
          4. Links to the Kepler mailing list
             1. Menu
             2. Contact Us (on index.html)
          5. Links to Lua Site
          6. Links to License
          7. Link to the project LuaForge sections on the left menu:
             1. Project home
             2. Bug Tracker
             3. CVS
      11. Validate XHTML and links. This can be done locally or remotely. If done remotely the files should be copied to a preview directory on (http://www.keplerproject.org/projectname/preview). A simple link checker can be found at http://validator.w3.org/checklink.
      12. README
          1. Reference to the project home page
          2. Version number
          3. Description of the directories and files
      13. Test project examples in the documentation
   4. Binary build for Windows, Linux and OSX
      1. Check Windows Visual Studio files
         1. Project Version in the .def file
   5. Configuration
   6. Instalation
   7. Unit tests
3. CVS details
   1. Branch using [dev|rel]_[0-9]_[0-9]_x
   2. Tag using v[0-9]_[0-9]_[0-9]_[a|b][2-9]
4. Generate the tar.gz and zip archives (using the Distribution Format)
   1. modulename-X.Y[.Z].tar.gz
   2. modulename-X.Y[.Z].zip
   3. modulename-X.Y[.Z]-win32-LuaXY.zip
5. Test the tgz and zip archives.
   1. Check included files
   2. Check the install/build process.
6. LuaForge project details
   1. Bug Tracker
      1. Categories (API, Documentation, Other)
      2. Groups (Version numbers)
   2. Feature Requests
      1. Categories (API, Documentation, Other)
      2. Groups ("Next Release")
7. Upload to LuaForge
   1. Create the release modulename-X.Y[.Z]
   2. Release and Change notes (the line breaks have to be manually positioned)
   3. Source tar.gz and zip files
   4. Binary zip files for Windows
8. Upload to ftp.keplerproject.org
   1. Documentation
   2. Logo and images
9. Links on www.keplerproject.org
   1. Home Page (US and BR)
   2. Status (US and BR)
   3. Side Bar (US and BR)
10. Update LuaForge project page
    1. Public Info
    2. Trove
11. Announce on the Kepler list
12. Announce on LuaForge
    1. LuaForge Home Approval
13. Announce on the Lua list