Difference between revisions of "Release Template"

From Free Pascal wiki
Jump to navigationJump to search
m (Keep lowercase "e" on screen)
(Restructuring the release template)
Line 1: Line 1:
 +
=== Release Issues ===
 +
 +
The issues page is [[Issues x.x.x]]
 +
 
=== Release preparations ===
 
=== Release preparations ===
  
 
#  Agree on deadline for changes and date for release candidate building
 
#  Agree on deadline for changes and date for release candidate building
−
#  Check the todo list for the particular release (should be linked from [[To Do lists]]) for status of individual todo items
+
## [[#FPC-x.x.xrc1]] deadline :
−
#  Check status of bugs assigned to that particular release in the bugtracker
+
## [[#FPC-x.x.x]] deadline :
 +
#  Check the [[Detailed 2.2.2 Todo]] list for the particular release (should be linked from [[To Do lists]]) for status of individual todo items
 +
#  Check status of [http://bugs.freepascal.org/roadmap_page.php bugs assigned to that particular release] in the bugtracker
 
#  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
 
#  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
 +
#  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]])
 
#  Ask platform maintainers and [[External_maintainers|external maintainers]] about including their platforms/builds in the new release
 
#  Ask platform maintainers and [[External_maintainers|external maintainers]] about including their platforms/builds in the new release
 
## Release-like building procedure should be performed in the appropriate branch (trunk or fixes depending on basis for the release)
 
## Release-like building procedure should be performed in the appropriate branch (trunk or fixes depending on basis for the release)
Line 29: Line 36:
 
#  Update whatsnew.txt (/install/doc/whatsnew.txt)
 
#  Update whatsnew.txt (/install/doc/whatsnew.txt)
 
#  Find testers
 
#  Find testers
−
## Create a page in Wiki ("Testers_X.Y.Z" based on [[Testers Template]])
+
## Create a [[Testers_x.x.x|testers]] page in Wiki (based on [[Testers Template]])
 
## 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)
 
## 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)
 +
#  Update path and file names in /install/macosx/*.info for the new version
 
#  Finish all source file updates
 
#  Finish all source file updates
−
#  Update version number to new release number
+
# convert /html/faq.fp to /install/doc/faq.htm and /install/doc/faq.txt
−
## /install/doc/readme.txt
 
−
## /installer/install.dat (header)
 
−
## /installer/install.pas (installer version)
 
−
## /install/fpc.spec
 
−
## convert /html/faq.fp to /install/doc/faq.htm and /install/doc/faq.txt
 
−
## /docs/fpc.sty (macro fpcversion)
 
−
## All Makefile.fpc files containing version=... (plus regenerate all corresponding Makefiles)
 
  
 
=== RC1 ===
 
=== RC1 ===
  
−
#  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]])
+
-- Below is a template for every version
 +
 
 
#  New directories
 
#  New directories
−
## Create new directories on ftp (/pub/fpc/beta/X.Y.Z-rcN and cpu-os under that)
+
## Create new directories on ftp (/pub/fpc/beta/X.Y.Z-rcN or /pub/fpc/dist/X.Y.Z and cpu-os under that)
 
## Copy the extra files (asld*.zip, gdb*.zip, make*.zip) from previous release (unless updated with new versions)
 
## Copy the extra files (asld*.zip, gdb*.zip, make*.zip) from previous release (unless updated with new versions)
−
#  Update path and file names in /install/macosx/*.info for the new RC
 
 
#  Add new section for the upcoming build in /install/debian/changelog
 
#  Add new section for the upcoming build in /install/debian/changelog
−
#  Create new rc branch in SVN (release_X_Y_Z_rcN)
+
#  Create new branch in SVN (release_X_Y_Z_rcN or release_X_Y_Z)
−
#  Update version number in rc branch to X.Y.Z-rcN
+
#  Update version number in release branch (and, if necessary also in main branch (trunk or fixes))
 
## /compiler/version.pas
 
## /compiler/version.pas
 +
## /install/doc/readme.txt
 +
## /installer/install.dat (header)
 +
## /installer/install.pas (installer version)
 +
## /install/fpc.spec
 +
## /docs/fpc.sty (macro fpcversion)
 +
## All Makefile.fpc files containing version=... (plus regenerate all corresponding Makefiles)
 
#  Create and upload exported fpcbuild
 
#  Create and upload exported fpcbuild
 
## fpcbuild-%{version}.zip
 
## fpcbuild-%{version}.zip
Line 68: Line 75:
 
## docs source (including link for short name version)
 
## docs source (including link for short name version)
 
## long name version for binary packages
 
## long name version for binary packages
−
#  Create and upload zip files for i386-go32v2
+
#  Create and upload binary releases (place the bame of the person who aggreed to build a release behind the name of the target below)
−
## basic zip (just binaries)
+
#* i386-go32v2/basic zip (just binaries)
−
## full zip (including docs and sources)
+
#* i386-go32v2/full zip (including docs and sources)
−
# Create and upload zip files for i386-os2
+
#* i386-os2/basic zip   (just binaries)
−
## basic zip (just binaries)
+
#* i386-os2/full zip     (including docs and sources)
−
## full zip (including docs and sources)
+
#* i386-win32/exe
−
# Create and upload installer exe for i386-win32
+
#* x86_64-win32/exe
−
# Create and upload tgz file for i386-freebsd
+
#* arm-wince/exe (cross-release)
−
# Create and upload release for i386-linux ([[Release engineering#Linux|more info]])
+
#* i386-freebsd/tgz
−
## tar
+
#* i386-linux/tar        ([[Release engineering#Linux|more info]])
−
## deb
+
#* i386-linux/deb        ([[Release engineering#Linux|more info]])
−
## rpm
+
#* i386-linux/rpm        ([[Release engineering#Linux|more info]])
−
# Create and upload release for powerpc-linux ([[Release engineering#Linux|more info]])
+
#* x86_64-linux/tar      ([[Release engineering#Linux|more info]])
−
## tar
+
#* x86_64-linux/deb      ([[Release engineering#Linux|more info]])
−
# Create and upload release for powerpc-macosx
+
#* x86_64-linux/rpm      ([[Release engineering#Linux|more info]])
−
## .dmg package
+
#* powerpc-linux/tar     ([[Release engineering#Linux|more info]])
−
# Create and upload release for i386-macosx
+
#* powerpc-macosx/dmg
−
## .dmg package
+
#* i386-macosx/dmg
−
## .info files for fink
+
#* i386-macosx/.info for fink  
−
# Create and upload release for powerpc-macos
+
#* powerpc-macos
−
# Create and upload release for powerpc-morphos
+
#* powerpc-morphos
−
# Create and upload release for powerpc-amiga
+
#* powerpc-amiga
−
# Create and upload zip files for i386-netware
+
#* i386-netware
−
# Create and upload zip files for i386-netwlibc
+
#* i386-netwlibc
−
# Create and upload release for sparc-linux ([[Release engineering#Linux|more info]])
+
#* sparc-linux/tar      ([[Release engineering#Linux|more info]])
−
## tar
+
#* sparc-sunos/tar
−
#  Create and upload release for sparc-sunos
+
#* arm-linux/tar (cross-release)
−
## tar
 
−
# Create and upload release for arm-linux (cross-release)
 
−
## tar
 
−
#  Create and upload release for x86_64-linux ([[Release engineering#Linux|more info]])
 
−
## tar
 
−
## deb
 
−
## rpm
 
 
#  Get it tested
 
#  Get it tested
 
## Ask dedicated testers for testing their platforms
 
## Ask dedicated testers for testing their platforms
 
## Consider announcing availability of the new RC in fpc-devel list
 
## Consider announcing availability of the new RC in fpc-devel list
 +
# Keep track of testing in [[Testers_x.x.x|the wiki]]
 +
 
#  Test the GO32v2 release
 
#  Test the GO32v2 release
 
## dos???.zip installation
 
## dos???.zip installation
Line 171: Line 173:
 
## faq.txt
 
## faq.txt
 
## whatsnew.txt
 
## whatsnew.txt
 +
 +
-- End of template for every version
  
 
=== RC2 ===
 
=== RC2 ===
Line 178: Line 182:
 
## Issue log
 
## Issue log
 
#  Look at unmerged changes in fpc and fpcbuild since the last RC and consider/ask for necessity of their inclusion in the release
 
#  Look at unmerged changes in fpc and fpcbuild since the last RC and consider/ask for necessity of their inclusion in the release
−
#  New directories
+
 
−
.
+
-- Template from above
−
.
 
  
 
=== Final release ===
 
=== Final release ===
  
 
#  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)
 
#  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)
−
#  New directories
+
 
−
## Create new directories on ftp (/pub/fpc/dist/cpu-os-X.Y.Z)
+
-- Template from above
−
## Copy the extra files (asld*.zip, gdb*.zip, make*.zip) from previous RC (unless updated with new versions)
 
−
#  Update path and file names in /install/macosx/*.info for the new release
 
−
#  Add new section for the upcoming build in /install/debian/changelog
 
−
#  Create new release branch in SVN
 
−
#  Update version number in release branch to the X.Y.Z
 
−
## /compiler/version.pas
 
−
#  Create and upload exported fpcbuild
 
−
## fpcbuild-%{version}.zip
 
−
## fpcbuild-%{version}.tar.gz
 
−
#  Create and upload the documentation ([[Release engineering#Documentation building and LaTeX limits|more info]])
 
−
## doc-pdf.zip
 
−
## doc-html.zip
 
−
## <i>doc-htm.zip</i> (not included)
 
−
## doc-txt.zip
 
−
## doc-ps.zip
 
−
## doc-pdf.tar.gz
 
−
## doc-html.tar.gz
 
−
## doc-ps.tar.gz
 
−
#  Create and upload source zips
 
−
## short name version for binary packages
 
−
## docs source (including link for short name version)
 
−
## long name version for binary packages
 
−
#  Create and upload zip files for i386-go32v2
 
−
## basic zip (just binaries)
 
−
## full zip (including docs and sources)
 
−
#  Create and upload zip files for i386-os2
 
−
## basic zip (just binaries)
 
−
## full zip (including docs and sources)
 
−
#  Create and upload installer exe for i386-win32
 
−
#  Create and upload tgz file for i386-freebsd
 
−
#  Create and upload release for i386-linux ([[Release engineering#Linux|more info]])
 
−
## tar
 
−
## deb
 
−
## rpm
 
−
#  Create and upload release for powerpc-linux ([[Release engineering#Linux|more info]])
 
−
## tar
 
−
#  Create and upload release for powerpc-macosx
 
−
## .dmg package
 
−
#  Create and upload release for i386-macosx
 
−
## .dmg package
 
−
#  Create and upload release for powerpc-macos
 
−
#  Create and upload release for powerpc-morphos
 
−
#  Create and upload release for powerpc-amiga
 
−
#  Create and upload zip files for i386-netware
 
−
#  Create and upload zip files for i386-netwlibc
 
−
#  Create and upload release for sparc-linux ([[Release engineering#Linux|more info]])
 
−
## tar
 
−
#  Create and upload release for arm-linux (cross-release)
 
−
## tar - Daniel
 
−
#  Create and upload release for x86_64-linux ([[Release engineering#Linux|more info]])
 
−
## tar
 
−
## deb
 
−
## rpm
 
−
#  Test the GO32v2 release
 
−
## dos???.zip installation
 
−
## dos???full.zip installation (over the previously installed dos???.zip to simulate updates)
 
−
## make sure readme.txt & whatsnew.txt are for the current version
 
−
## run all executables in /bin/go32v2 (no params)
 
−
## make cycle with newly installed binaries and sources
 
−
## run testsuite
 
−
## open the installed hello.pp in IDE
 
−
## make a minor change in the demo in IDE & save it
 
−
## view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
 
−
## compile the demo file in IDE
 
−
## <i>run the demo within the IDE (debugger)</i> (debugging in IDE currently not available/working)
 
−
#  Test the OS/2 release
 
−
## os2???.zip installation
 
−
## os2???full.zip installation (over the previously installed os2???.zip to simulate updates)
 
−
## make sure readme.txt & whatsnew.txt are for the current version
 
−
## run all executables in /bin/os2 (no params)
 
−
## make cycle with newly installed binaries and sources
 
−
## run testsuite
 
−
## open the installed hello.pp in IDE
 
−
## make a minor change in the demo in IDE & save it
 
−
## view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
 
−
## compile the demo file in IDE
 
−
## <i>run the demo within the IDE (debugger)</i> (not supported)
 
−
#  Test the Win32 release
 
−
## Run installer
 
−
## make sure readme.txt & whatsnew.txt are for the current version
 
−
## run all executables in /bin/win32 (without parameters)
 
−
## make cycle with newly installed binaries and sources
 
−
## run testsuite
 
−
## open the installed hello.pp in IDE
 
−
## make a minor change in the demo in IDE & save it
 
−
## view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
 
−
## compile the demo file in IDE
 
−
## run the demo within the IDE (debugger)
 
−
#  Test release for i386-freebsd
 
−
#  Test release for i386-linux
 
−
## tar
 
−
## deb
 
−
## rpm
 
−
#  Test release for powerpc-linux
 
−
## tar
 
−
#  Test release for powerpc-macosx
 
−
## .dmg package
 
−
#  Test release for i386-macosx
 
−
## .dmg package
 
−
#  Test release for powerpc-macos
 
−
#  Test release for powerpc-morphos
 
−
#  Test release for powerpc-amiga
 
−
#  Test release for i386-netware
 
−
#  Test release for i386-netwlibc
 
−
#  Test release for sparc-linux
 
−
## tar
 
−
#  Test release for arm-linux
 
−
## tar
 
−
#  Test release for x86_64-linux
 
−
## tar
 
−
## deb
 
−
## rpm
 
−
#  Check PDF documentation (open all files)
 
−
#  Check HTML documentation
 
−
#  Check TXT documentation
 
−
#  Read updated text files as distributed in release zip files
 
−
## readme.txt
 
−
## faq.txt
 
−
## whatsnew.txt
 
  
 
=== Going public ===
 
=== Going public ===

Revision as of 14:33, 2 January 2009

Release Issues

The issues page is Issues x.x.x

Release preparations

  1. Agree on deadline for changes and date for release candidate building
    1. #FPC-x.x.xrc1 deadline :
    2. #FPC-x.x.x deadline :
  2. Check the Detailed 2.2.2 Todo list for the particular release (should be linked from To Do lists) for status of individual todo items
  3. Check status of bugs assigned to that particular release in the bugtracker
  4. 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
  5. 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)
  6. Ask platform maintainers and external maintainers about including their platforms/builds in the new release
    1. Release-like building procedure should be performed in the appropriate branch (trunk or fixes depending on basis for the release)
  7. 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
  8. 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
    2. Repackage and upload additional tools where needed
  9. Update whatsnew.txt (/install/doc/whatsnew.txt)
  10. 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)
  11. Update path and file names in /install/macosx/*.info for the new version
  12. Finish all source file updates
  13. convert /html/faq.fp to /install/doc/faq.htm and /install/doc/faq.txt

RC1

-- Below is a template for every version

  1. New directories
    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
  3. Create new branch in SVN (release_X_Y_Z_rcN or release_X_Y_Z)
  4. Update version number in release branch (and, if necessary also in main branch (trunk or fixes))
    1. /compiler/version.pas
    2. /install/doc/readme.txt
    3. /installer/install.dat (header)
    4. /installer/install.pas (installer version)
    5. /install/fpc.spec
    6. /docs/fpc.sty (macro fpcversion)
    7. All Makefile.fpc files containing version=... (plus regenerate all corresponding Makefiles)
  5. Create and upload exported fpcbuild
    1. fpcbuild-%{version}.zip
    2. fpcbuild-%{version}.tar.gz
  6. Create and upload the documentation (more info)
    1. doc-pdf.zip
    2. doc-html.zip
    3. doc-htm.zip (not included)
    4. doc-txt.zip
    5. doc-ps.zip
    6. doc-pdf.tar.gz
    7. doc-html.tar.gz
    8. doc-ps.tar.gz
  7. Create and upload source zips
    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 bame of the person who aggreed 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-win32/exe
    • arm-wince/exe (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)
    • powerpc-macosx/dmg
    • i386-macosx/dmg
    • i386-macosx/.info for fink
    • powerpc-macos
    • powerpc-morphos
    • powerpc-amiga
    • i386-netware
    • i386-netwlibc
    • sparc-linux/tar (more info)
    • sparc-sunos/tar
    • arm-linux/tar (cross-release)
  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
  1. Test the GO32v2 release
    1. dos???.zip installation
    2. dos???full.zip installation (over the previously installed dos???.zip to simulate updates)
    3. make sure readme.txt & whatsnew.txt are for the current version
    4. run all executables in /bin/go32v2 (no params)
    5. make cycle with newly installed binaries and sources
    6. run testsuite
    7. open the installed hello.pp in IDE
    8. make a minor change in the demo in IDE & save it
    9. view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
    10. compile the demo file in IDE
    11. run the demo within the IDE (debugger)
  2. Test the OS/2 release
    1. os2???.zip installation
    2. os2???full.zip installation (over the previously installed os2???.zip to simulate updates)
    3. make sure readme.txt & whatsnew.txt are for the current version
    4. run all executables in /bin/os2 (no params)
    5. make cycle with newly installed binaries and sources
    6. run testsuite
    7. open the installed hello.pp in IDE
    8. make a minor change in the demo in IDE & save it
    9. view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
    10. compile the demo file in IDE
    11. run the demo within the IDE (debugger) (not supported)
  3. Test the Win32 release
    1. Run installer
    2. make sure readme.txt & whatsnew.txt are for the current version
    3. run all executables in /bin/win32 (without parameters)
    4. make cycle with newly installed binaries and sources
    5. run testsuite
    6. open the installed hello.pp in IDE
    7. make a minor change in the demo in IDE & save it
    8. view documentation in IDE, traverse 2-3 pages (at least one with screenshots)
    9. compile the demo file in IDE
    10. run the demo within the IDE (debugger)
  4. Test release for i386-freebsd
  5. Test release for i386-linux
    1. tar
    2. deb
    3. rpm
  6. Test release for powerpc-linux
    1. tar
  7. Test release for powerpc-macosx
    1. .dmg package
  8. Test release for i386-macosx
    1. .dmg package
  9. Test release for powerpc-macos
  10. Test release for powerpc-morphos
  11. Test release for powerpc-amiga
  12. Test release for i386-netware
  13. Test release for i386-netwlibc
  14. Test release for sparc-linux
    1. tar
  15. Test release for arm-linux
    1. tar
  16. Test release for x86_64-linux
    1. tar
    2. deb
    3. rpm
  17. Check PDF documentation (open all files)
  18. Check HTML documentation
  19. Check TXT documentation
  20. Read updated text files as distributed in release zip files
    1. readme.txt
    2. faq.txt
    3. whatsnew.txt

-- End of template for every version

RC2

  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)

-- Template from above

Going public

  1. Make new version numbers (release plus next odd patch number for continuing fixes) available in bug tracker
  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 old version to the olddist/<version>
    3. upload files to SourceForge.net and add them to new "releases" for individual platforms
    4. make new "releases" on SourceForge.net accessible for users (change status to "active")
    5. Allow automated notifications on individual SourceForge.net 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. /html/fpc.fp
    5. /html/faq.fp (things like "the latest version is ...")
  6. 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)
  7. 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)
  8. Check the WWW pages
    1. make sure http://www.freepascal.org contains the new version already
    2. read news.html
    3. read fpc.html
    4. read download.html and check links to individual files
  9. Send announcement to our mailing lists
  10. Post announcement on the community site
  11. Post announcement on Sourceforge.net (only "Project Administrators" may do it)
  12. Make sure that all unfixed issues encountered during RC testing and listed on dedicated page in Wiki are documented in bug tracker too
  13. Revise / update /html/future.fp after major versions (?.?.0)
  14. Remove unneeded RC builds from FTP
Retrieved from "http://wiki.freepascal.org/index.php?title=Release_Template&oldid=32973"