Release Template

From Free Pascal wiki
Jump to navigationJump to search

Release Issues

The issues page is Issues x.y.z (from Issues Template )

Release preparations

  1. For major versions check major versions to do
  2. Send a mail to fpc-devel to announce that the fixes branch is frozen for the benefit of committers that are not on core (or do not read it regularly)
  3. Agree on deadline for changes and date for release candidate building
    1. Contact platform maintainers who are not subscribed to the core list and notify them about upcoming release and ask them for their inputs into the release schedule
      1. Olivier Coursiere - Haiku
      2. Karl-Michael Schindler - Mac OS X - fink
    2. #FPC-x.y.zrc1 deadline:
    3. #FPC-x.y.z deadline:
  4. Check the Detailed x.y.z Todo list for the particular release (should be linked from To Do lists) for status of individual todo items
  5. Check status of bugs assigned to that particular release in the bugtracker
  6. New page in Wiki named "Release_x.y.z" for release procedure with steps needed and their status (based on Release Template), at the beginning consisting of (at least) RC1 and final release sections. If it is a final release add a link it to Releasing
  7. Create new page in Wiki with issue log for documentation of issues encountered in release candidates and their status ("Issues_x.y.z" based on Issues Template)
  8. Move merged changes from User Changes Trunk to the appropriate User Changes x.y.z page, possibly adding changes that were merged but not added to the trunk page, plus update the reference to the changes in previous release from the page for trunk so that it refers the page with changes for the new release
  9. Update the version number/svn revision of all bug reports in mantis for which the patches were merged but that have not yet been updated (for )
  10. Ask platform maintainers and external maintainers about including their platforms/builds in the new release
  11. Check and update all .msg files
    1. errore.msg
    2. errord.msg
    3. errorf.msg
    4. errorn.msg
    5. errorr.msg
    6. errorrw.msg
    7. errorues.msg
    8. errores.msg
    9. errorct.msg
    10. errorhe.msg
    11. errorheu.msg
    12. errorptd.msg
    13. errorptw.msg
    14. errorpli.msg
    15. errorpl.msg
    16. errorid.msg
  12. Check tools
    1. Check version of the above mentioned tools (GNU tools, helper DLLs, UPX, etc.), and decide whether it isn't time to update some of these tools. See helper tools
    2. Repackage and upload additional tools where needed
  13. Update whatsnew.txt (/install/doc/whatsnew.txt)
  14. Find testers
    1. Create a testers page in Wiki (based on Testers Template)
    2. Ask in fpc-devel list for volunteers interested in testing the individual platforms / builds and list them on the newly created page (they can add themselves)
  15. Update path and file names in /install/macosx/*.info for the new version
  16. Update path and file names in /install/ for the new version
  17. Finish all source file updates
  18. convert /html/faq.fp to /install/doc/faq.htm and /install/doc/faq.txt (more info)


-- Below is a template for every version

  1. New directories (more info)
    1. Create new directories on ftp (/pub/fpc/beta/X.Y.Z-rcN or /pub/fpc/dist/X.Y.Z and cpu-os under that)
    2. Copy the extra files (asld*.zip, gdb*.zip, make*.zip) from previous release (unless updated with new versions)
  2. Add new section for the upcoming build in /install/debian/changelog (more info)
  3. Create new branch in SVN (release_X_Y_Z_rcN or release_X_Y_Z) (more info)
  4. Update version number in release branch (and, if necessary also in main branch (trunk or fixes)) (more info)
    1. /compiler/version.pas
    2. /install/doc/readme.txt
    3. /install/doc/whatsnew.txt
    4. /installer/install.dat (header)
    5. /installer/install.pas (installer version)
    6. /docs/fpc.sty (macro fpcversion)
    7. All Makefile.fpc files containing version=... (plus regenerate all corresponding Makefiles) (more info)
    8. All version-numbers in fpmake.pp files (more info)
  5. Create and upload exported fpcbuild (more info)
    1. fpcbuild-%{version}.zip
    2. fpcbuild-%{version}.tar.gz
    3. fpc-%{version}
    4. fpc-%{version}-source.tar.gz
  6. Create and upload the documentation (more info)
    3. (not included)
    6. doc-pdf.tar.gz
    7. doc-html.tar.gz
    8. doc-ps.tar.gz
  7. Create and upload source zips (more info)
    1. short name version for binary packages
    2. docs source (including link for short name version)
    3. long name version for binary packages
  8. Create and upload binary releases (place the name of the person who agreed to build a release behind the name of the target below)
    • i386-go32v2/basic zip (just binaries)
    • i386-go32v2/full zip (including docs and sources)
    • i386-os2/basic zip (just binaries)
    • i386-os2/full zip (including docs and sources)
    • i386-win32/exe
    • x86_64-win64/exe
    • arm-wince/exe (cross-release)
    • arm-symbian (cross-release)
    • i386-symbian (cross-release)
    • arm-gba (cross-release)
    • arm-nds (cross-release)
    • powerpc-wii (cross-release)
    • i386-freebsd/tgz
    • i386-linux/tar (more info)
    • i386-linux/deb (more info)
    • i386-linux/rpm (more info)
    • x86_64-linux/tar (more info)
    • x86_64-linux/deb (more info)
    • x86_64-linux/rpm (more info)
    • powerpc-linux/tar (more info)
    • powerpc64-linux/tar (more info)
    • powerpc-macosx/dmg
    • i386-macosx/dmg
    • i386->powerpc-macosx/dmg
    • i386->ios-macosx/dmg
    • x86_64-macosx/.info for fink
    • powerpc-macos
    • sparc-linux/tar (more info)
    • sparc-linux/deb (more info)
    • arm-linux/tar (cross-release)
    • powerpc-morphos
    • powerpc-amiga
    • i386-netware
    • i386-netwlibc
    • i386-haiku
    • i386-sunos/tar
    • sparc-sunos/tar
  9. Get it tested
    1. Ask dedicated testers for testing their platforms
    2. Consider announcing availability of the new RC in fpc-devel list
  10. Keep track of testing in the wiki

-- End of template for every version


  1. Section for new RC on release pages in Wiki
    1. Release procedure
    2. Issue log
  2. Look at unmerged changes in fpc and fpcbuild since the last RC and consider/ask for necessity of their inclusion in the release

-- Template from above

Final release

  1. Look at unmerged changes in fpc and fpcbuild since the last RC and consider/ask for necessity of their inclusion in the release (only cosmetic changes should be included, otherwise a new RC is needed instead of final release)
  2. Check all bugreports marked fixed with the previous fixes version, or trunk if they apply to the release. (iow if the release packages the fix). If they are fixed, set their "fixed in version" setting to the release version, and update the "fixed in revision" to the revision the fix was merged to release_ or fixes_ branch.

-- Template from above

Going public

  1. Make new version numbers (release plus next odd patch number for continuing fixes) available in bug tracker (don't forget to set releases to "released", or they won't be visible to users.)
  2. Make new version numbers (release plus next odd patch number for continuing fixes) available in testsuite db
  3. Make new files on FTP available to wide public
    1. update symlinks (no symlinks any more?)
    2. Move the releases older than 18 months to the olddist/<version> dir.
    3. Publish files on
      1. Upload files to and add them to new "releases" for individual platforms
      2. Mark the latest whatsnew.txt file as a "Release info" file (using properties of that file in File Manager pages)
      3. Select this release info file for the respective folders containing the new release
      4. Check that the right files are selected as default for the individual platforms recognized by (use the latest readme.txt as the default download for "All other")
      5. Make new "releases" on accessible for users (change status to "active")
      6. Allow automated notifications on individual file release pages to be sent
  4. Submit darwin packages to fink
  5. Update WWW pages
    1. /html/news.fp
    2. /html/down/* (links to all individual files & file sizes)
    3. /html/download.fp (version number and list of platforms)
    4. Search for the old version number (both with and without dots) in all files under /html/down/ (e.g. using grep) and fix where necessary
    5. /html/fpc.fp
    6. /html/faq.fp (things like "the latest version is ...")
  6. Update docs linked from the WWW server ( to those from the new release
    1. Unpack the html docs to docs-html on the WWW server
    2. Unpack the PDF files (without subdirectory) to docs-pdf on ftpmaster
  7. Create new fixes branch (only after a major release -  ?.?.0)
    1. Update version number in the trunk branch (only after a major release -  ?.?.0)
      1. /compiler/version.pas
      2. All Makefile.fpc files containing "version=..." (plus regenerate the corresponding Makefiles)
  8. Update version number in the fixes branch (increase the patch to next odd number)
    1. /compiler/version.pas
    2. all Makefile.fpc files containing "version=..." (plus regenerate the corresponding Makefiles)
  9. Check the WWW pages
    1. make sure contains the new version already
    2. read news.html
    3. read fpc.html
    4. read download.html and check links to individual files
  10. Send announcement to our mailing lists
  11. Post announcement on the community site
  12. Post announcement on (only "Project Administrators" may do it)
  13. Make sure that all unfixed issues encountered during RC testing and listed on dedicated page in Wiki are documented in bug tracker too
  14. Revise / update /html/future.fp after major versions (?.?.0)
  15. Remove unneeded RC builds from FTP
  16. Add the version to the versioncheck in the topfile makefile.

See also