Release Template: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | ### Release Issues | |
| 2 | 2 | ||
| 3 | 3 | The issues page is [[Issues x.y.z]] (from [[Issues Template]] ) | |
| 4 | 4 | ||
| 5 | 5 | ### Release preparations | |
| 6 | 6 | ||
| 7 | 7 | 1. For major versions check [[Release engineering|major versions to do]] | |
| 8 | 8 | 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) | |
| 9 | 9 | 3. Agree on deadline for changes and date for release candidate building | |
| 10 | 10 | 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 | |
| 11 | 11 | 1. Olivier Coursiere - Haiku | |
| 12 | 12 | 2. Karl-Michael Schindler - Mac OS X - fink | |
| 13 | 13 | 2. #FPC-x.y.zrc1 deadline: | |
| 14 | 14 | 3. #FPC-x.y.z deadline: | |
| 15 | 15 | 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 | |
| 16 | 16 | 5. Check status of [bugs assigned to that particular release](http://bugs.freepascal.org/roadmap_page.php) in the bugtracker | |
| 17 | 17 | 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]] | |
| 18 | 18 | 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]]) | |
| 19 | 19 | 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 | |
| 20 | 20 | 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 <http://bugs.freepascal.org/changelog_page.php> ) | |
| 21 | 21 | 10. Ask platform maintainers and [[External maintainers|external maintainers]] about including their platforms/builds in the new release | |
| 22 | 22 | 11. Check and update all .msg files | |
| 23 | 23 | 1. errore.msg | |
| 24 | 24 | 2. errord.msg | |
| 25 | 25 | 3. errorf.msg | |
| 26 | 26 | 4. errorn.msg | |
| 27 | 27 | 5. errorr.msg | |
| 28 | 28 | 6. errorrw.msg | |
| 29 | 29 | 7. errorues.msg | |
| 30 | 30 | 8. errores.msg | |
| 31 | 31 | 9. errorct.msg | |
| 32 | 32 | 10. errorhe.msg | |
| 33 | 33 | 11. errorheu.msg | |
| 34 | 34 | 12. errorptd.msg | |
| 35 | 35 | 13. errorptw.msg | |
| 36 | 36 | 14. errorpli.msg | |
| 37 | 37 | 15. errorpl.msg | |
| 38 | 38 | 16. errorid.msg | |
| 39 | 39 | 12. Check tools | |
| 40 | 40 | 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]] | |
| 41 | 41 | 2. Repackage and upload additional tools where needed | |
| 42 | 42 | 13. Update whatsnew.txt (/install/doc/whatsnew.txt) | |
| 43 | 43 | 14. Find testers | |
| 44 | 44 | 1. Create a [[Testers x.y.z|testers]] page in Wiki (based on [[Testers Template]]) | |
| 45 | 45 | 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) | |
| 46 | 46 | 15. Update path and file names in /install/macosx/*.info for the new version | |
| 47 | 47 | 16. Update path and file names in /install/fpc.ist for the new version | |
| 48 | 48 | 17. Finish all source file updates | |
| 49 | 49 | 18. convert /html/faq.fp to /install/doc/faq.htm and /install/doc/faq.txt ([[Release engineering|more info]]) | |
| 50 | 50 | ||
| 51 | 51 | ### RC1 | |
| 52 | 52 | ||
| 53 | 53 | -- Below is a template for every version | |
| 54 | 54 | ||
| 55 | 55 | 1. New directories ([[Release engineering|more info]]) | |
| 56 | 56 | 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) | |
| 57 | 57 | 2. Copy the extra files (asld*.zip, gdb*.zip, make*.zip) from previous release (unless updated with new versions) | |
| 58 | 58 | 2. Add new section for the upcoming build in /install/debian/changelog ([[Release engineering|more info]]) | |
| 59 | 59 | 3. Create new branch in SVN (release_X_Y_Z_rcN or release_X_Y_Z) ([[Release engineering|more info]]) | |
| 60 | 60 | 4. Update version number in release branch (and, if necessary also in main branch (trunk or fixes)) ([[Release engineering|more info]]) | |
| 61 | 61 | 1. /compiler/version.pas | |
| 62 | 62 | 2. /install/doc/readme.txt | |
| 63 | 63 | 3. /install/doc/whatsnew.txt | |
| 64 | 64 | 4. /installer/install.dat (header) | |
| 65 | 65 | 5. /installer/install.pas (installer version) | |
| 66 | 66 | 6. /docs/fpc.sty (macro fpcversion) | |
| 67 | 67 | 7. All Makefile.fpc files containing version=... (plus regenerate all corresponding Makefiles) ([[Release engineering|more info]]) | |
| 68 | 68 | 8. All version-numbers in fpmake.pp files ([[Release engineering|more info]]) | |
| 69 | 69 | 5. Create and upload exported fpcbuild ([[Release engineering|more info]]) | |
| 70 | 70 | 1. fpcbuild-%{version}.zip | |
| 71 | 71 | 2. fpcbuild-%{version}.tar.gz | |
| 72 | 72 | 3. fpc-%{version}-source.zip | |
| 73 | 73 | 4. fpc-%{version}-source.tar.gz | |
| 74 | 74 | 6. Create and upload the documentation ([[Release engineering|more info]]) | |
| 75 | 75 | 1. doc-pdf.zip | |
| 76 | 76 | 2. doc-html.zip | |
| 77 | - | ||
| 77 | + | 3. doc-htm.zip (not included) | |
| 78 | 78 | 4. doc-txt.zip | |
| 79 | 79 | 5. doc-ps.zip | |
| 80 | 80 | 6. doc-pdf.tar.gz | |
| 81 | 81 | 7. doc-html.tar.gz | |
| 82 | 82 | 8. doc-ps.tar.gz | |
| 83 | 83 | 7. Create and upload source zips ([[Release engineering|more info]]) | |
| 84 | 84 | 1. short name version for binary packages | |
| 85 | 85 | 2. docs source (including link for short name version) | |
| 86 | 86 | 3. long name version for binary packages | |
| 87 | 87 | 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) | |
| 88 | 88 | - i386-go32v2/basic zip (just binaries) | |
| 89 | 89 | - i386-go32v2/full zip (including docs and sources) | |
| 90 | 90 | - i386-os2/basic zip (just binaries) | |
| 91 | 91 | - i386-os2/full zip (including docs and sources) | |
| 92 | 92 | - i386-win32/exe | |
| 93 | 93 | - x86_64-win64/exe | |
| 94 | 94 | - arm-wince/exe (cross-release) | |
| 95 | 95 | - arm-symbian (cross-release) | |
| 96 | 96 | - i386-symbian (cross-release) | |
| 97 | 97 | - arm-gba (cross-release) | |
| 98 | 98 | - arm-nds (cross-release) | |
| 99 | 99 | - powerpc-wii (cross-release) | |
| 100 | 100 | - i386-freebsd/tgz | |
| 101 | 101 | - i386-linux/tar ([[Release engineering|more info]]) | |
| 102 | 102 | - i386-linux/deb ([[Release engineering|more info]]) | |
| 103 | 103 | - i386-linux/rpm ([[Release engineering|more info]]) | |
| 104 | 104 | - x86_64-linux/tar ([[Release engineering|more info]]) | |
| 105 | 105 | - x86_64-linux/deb ([[Release engineering|more info]]) | |
| 106 | 106 | - x86_64-linux/rpm ([[Release engineering|more info]]) | |
| 107 | 107 | - powerpc-linux/tar ([[Release engineering|more info]]) | |
| 108 | 108 | - powerpc64-linux/tar ([[Release engineering|more info]]) | |
| 109 | 109 | - powerpc-macosx/dmg | |
| 110 | 110 | - i386-macosx/dmg | |
| 111 | 111 | - i386-\>powerpc-macosx/dmg | |
| 112 | 112 | - i386-\>ios-macosx/dmg | |
| 113 | 113 | - x86_64-macosx/.info for fink | |
| 114 | 114 | - powerpc-macos | |
| 115 | 115 | - sparc-linux/tar ([[Release engineering|more info]]) | |
| 116 | 116 | - sparc-linux/deb ([[Release engineering|more info]]) | |
| 117 | 117 | - arm-linux/tar (cross-release) | |
| 118 | 118 | - powerpc-morphos | |
| 119 | 119 | - powerpc-amiga | |
| 120 | 120 | - i386-netware | |
| 121 | 121 | - i386-netwlibc | |
| 122 | 122 | - i386-haiku | |
| 123 | 123 | - i386-sunos/tar | |
| 124 | 124 | - sparc-sunos/tar | |
| 125 | 125 | 9. Get it tested | |
| 126 | 126 | 1. Ask dedicated testers for testing their platforms | |
| 127 | 127 | 2. Consider announcing availability of the new RC in fpc-devel list | |
| 128 | 128 | 10. Keep track of testing in [[Testers x.x.x|the wiki]] | |
| 129 | 129 | ||
| 130 | 130 | -- End of template for every version | |
| 131 | 131 | ||
| 132 | 132 | ### RC2 | |
| 133 | 133 | ||
| 134 | 134 | 1. Section for new RC on release pages in Wiki | |
| 135 | 135 | 1. Release procedure | |
| 136 | 136 | 2. Issue log | |
| 137 | 137 | 2. Look at unmerged changes in fpc and fpcbuild since the last RC and consider/ask for necessity of their inclusion in the release | |
| 138 | 138 | ||
| 139 | 139 | -- Template from above | |
| 140 | 140 | ||
| 141 | 141 | ### Final release | |
| 142 | 142 | ||
| 143 | 143 | 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) | |
| 144 | 144 | 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. | |
| 145 | 145 | ||
| 146 | 146 | -- Template from above | |
| 147 | 147 | ||
| 148 | 148 | ### Going public | |
| 149 | 149 | ||
| 150 | 150 | 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.) | |
| 151 | 151 | 2. Make new version numbers (release plus next odd patch number for continuing fixes) available in testsuite db | |
| 152 | 152 | 3. Make new files on FTP available to wide public | |
| 153 | - | ||
| 153 | + | 1. update symlinks (no symlinks any more?) | |
| 154 | 154 | 2. Move the releases older than 18 months to the olddist/\<version\> dir. | |
| 155 | 155 | 3. Publish files on SourceForge.net | |
| 156 | 156 | 1. Upload files to SourceForge.net and add them to new "releases" for individual platforms | |
| 157 | 157 | 2. Mark the latest whatsnew.txt file as a "Release info" file (using properties of that file in File Manager pages) | |
| 158 | 158 | 3. Select this release info file for the respective folders containing the new release | |
| 159 | 159 | 4. Check that the right files are selected as default for the individual platforms recognized by SourceForge.net (use the latest readme.txt as the default download for "All other") | |
| 160 | 160 | 5. Make new "releases" on SourceForge.net accessible for users (change status to "active") | |
| 161 | 161 | 6. Allow automated notifications on individual SourceForge.net file release pages to be sent | |
| 162 | 162 | 4. Submit darwin packages to fink | |
| 163 | 163 | 5. Update WWW pages | |
| 164 | 164 | 1. /html/news.fp | |
| 165 | 165 | 2. /html/down/* (links to all individual files & file sizes) | |
| 166 | 166 | 3. /html/download.fp (version number and list of platforms) | |
| 167 | 167 | 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 | |
| 168 | 168 | 5. /html/fpc.fp | |
| 169 | 169 | 6. /html/faq.fp (things like "the latest version is ...") | |
| 170 | 170 | 6. Update docs linked from the WWW server (http://www.freepascal.org/docs.var) to those from the new release | |
| 171 | 171 | 1. Unpack the html docs to docs-html on the WWW server | |
| 172 | 172 | 2. Unpack the PDF files (without subdirectory) to docs-pdf on ftpmaster | |
| 173 | 173 | 7. Create new fixes branch (only after a major release - ?.?.0) | |
| 174 | 174 | 1. Update version number in the trunk branch (only after a major release - ?.?.0) | |
| 175 | 175 | 1. /compiler/version.pas | |
| 176 | 176 | 2. All Makefile.fpc files containing "version=..." (plus regenerate the corresponding Makefiles) | |
| 177 | 177 | 8. Update version number in the fixes branch (increase the patch to next odd number) | |
| 178 | 178 | 1. /compiler/version.pas | |
| 179 | 179 | 2. all Makefile.fpc files containing "version=..." (plus regenerate the corresponding Makefiles) | |
| 180 | 180 | 9. Check the WWW pages | |
| 181 | 181 | 1. make sure <http://www.freepascal.org> contains the new version already | |
| 182 | 182 | 2. read news.html | |
| 183 | 183 | 3. read fpc.html | |
| 184 | 184 | 4. read download.html and check links to individual files | |
| 185 | 185 | 10. Send announcement to our mailing lists | |
| 186 | 186 | 11. Post announcement on the community site | |
| 187 | 187 | 12. Post announcement on Sourceforge.net (only "Project Administrators" may do it) | |
| 188 | 188 | 13. Make sure that all unfixed issues encountered during RC testing and listed on dedicated page in Wiki are documented in bug tracker too | |
| 189 | 189 | 14. Revise / update /html/future.fp after major versions (?.?.0) | |
| 190 | 190 | 15. Remove unneeded RC builds from FTP | |
| 191 | 191 | 16. Add the version to the versioncheck in the topfile makefile. | |
| 192 | 192 | ||
| 193 | 193 | ### See also | |
| 194 | 194 | ||
| 195 | 195 | - [[Release engineering]] | |
| 196 | 196 | - [[Detailed Lazarus release template todo|comparable Lazarus document]] | |
| 197 | 197 | ||
| 198 | 198 | --- | |
| 199 | 199 | *From the Free Pascal wiki, page "Release Template", as it stood on 2020-08-26 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 200 | 200 | Category: FPC development | |
| 201 | 201 | Category: FPC release | |
| 202 | 202 | Category: Release engineering |