Lazarus release engineering: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | > **Note:** This page is still work in progress. For feedback please use our mailing list. | |
| 2 | 2 | ||
| 3 | 3 | ## Checklist | |
| 4 | 4 | ||
| 5 | - | ||
| 6 | - | ||
| 7 | - | ||
| 8 | - | ||
| 9 | - | ||
| 10 | - | ||
| 11 | 5 | ### Major Release | |
| 12 | 6 | ||
| 13 | 7 | - Decide on new release | |
| 14 | 8 | - Check internally with the team | |
| 15 | 9 | - Decide on approx Date for first RC (date may change). This may be optional. | |
| 16 | 10 | - Prepare | |
| 17 | 11 | - Create fixes branch in SVN | |
| 18 | 12 | - Create fixes page on wiki | |
| 19 | 13 | - Announce | |
| 20 | - | ||
| 21 | - | ||
| 14 | + | - Special announcement for translators. | |
| 15 | + | - Public announcement with approx RC date (if available). | |
| 22 | 16 | ||
| 23 | 17 | ### For each Release Candidate | |
| 24 | 18 | ||
| 25 | 19 | - Between 1 and 2 weeks before RC is due | |
| 26 | 20 | - Check internally with the team | |
| 27 | - | ||
| 21 | + | - Public reminder/announcement that RC is due. | |
| 28 | 22 | - If needed: Reschedule/Delay | |
| 29 | 23 | - Publish the Release Candidate | |
| 30 | 24 | - Tag RC in SVN | |
| 31 | 25 | - Build and upload | |
| 32 | - | ||
| 26 | + | - Public announcement of RC | |
| 33 | 27 | ||
| 34 | 28 | Typical life time of an RC can be expected to be between 3 and 6 weeks. But in the end will be decided at the discretion of the team. | |
| 35 | 29 | ||
| 36 | 30 | ### For the Release | |
| 37 | 31 | ||
| 38 | 32 | - At least 2 weeks before Release | |
| 39 | 33 | - Check internally with the team | |
| 40 | 34 | - Public reminder/announcement that Release is due. No more RC planned. | |
| 41 | - | ||
| 35 | + | - Repeat Special announcement for translators. | |
| 42 | 36 | - 1 week before Release - Depending on feedback (the team should have 3 or 4 days time to discuss this): | |
| 43 | 37 | - - keep decision to release | |
| 44 | 38 | - move date of release | |
| 45 | 39 | - schedule another RC | |
| 46 | - | ||
| 40 | + | - 3 to 5 days later: Public announcement of above decision, if a change to the plan was made. | |
| 47 | 41 | - Make the Release | |
| 48 | 42 | - Tag RC in SVN | |
| 49 | 43 | - Build and upload | |
| 50 | - | ||
| 51 | - | ||
| 52 | - | ||
| 53 | - | ||
| 54 | - | ||
| 44 | + | - Public announcement of Release | |
| 55 | 45 | ||
| 56 | 46 | ### Minor Release | |
| 57 | 47 | ||
| 58 | 48 | - Decide on new Release (Day: approx -4 / Duration 3-4 days) | |
| 59 | 49 | - Check internally with the team (3 to 4 days) | |
| 60 | 50 | - Release Date will be 2 weeks from announcement (1 week for community feedback) | |
| 61 | 51 | - Prepare | |
| 62 | 52 | - Update fixes page on wiki (New section "Fixes for ..." next release | |
| 63 | 53 | ||
| 64 | 54 | - Announce upcoming Release (Day: 0 / Duration 7-8 days) | |
| 65 | - | ||
| 66 | - | ||
| 55 | + | - Special announcement for translators. | |
| 56 | + | - Public announcement with approx date. | |
| 67 | 57 | ||
| 68 | 58 | - Forum | |
| 69 | 59 | ||
| 70 | 60 | ||
| 71 | 61 | Ask for | |
| 72 | 62 | ||
| 73 | 63 | - new regressions | |
| 74 | 64 | - missing merges | |
| 75 | 65 | ||
| 76 | 66 | Community has about 1 week to respond. Urgent matters can still be reported during "approve" phase. | |
| 77 | 67 | ||
| 78 | 68 | Depending on feedback received: reschedule and if needed re-announce. | |
| 79 | 69 | ||
| 80 | 70 | #### Approve Release (Start at day: 7 to 9 / Duration 3/4 days) | |
| 81 | 71 | ||
| 82 | 72 | - Check internally with the team (3 to 4 days) | |
| 83 | 73 | ||
| 84 | 74 | Depending on feedback received: reschedule and if needed re-announce. | |
| 85 | 75 | ||
| 86 | 76 | #### Prepare Release (Start at day: 10 to 12 / Duration 3/4 days) | |
| 87 | 77 | ||
| 88 | 78 | - TAG SVN | |
| 89 | 79 | - Build docs =\> update binaries svn | |
| 90 | 80 | - Start building | |
| 91 | 81 | - Build Release binaries | |
| 92 | 82 | - Test | |
| 93 | 83 | - Upload (staged) | |
| 94 | 84 | ||
| 95 | 85 | At the same time: | |
| 96 | 86 | ||
| 97 | 87 | - Update mantis | |
| 98 | 88 | - Collect checksums and commit to web-page svn | |
| 99 | 89 | - Optional: Update webpage to contain checksums | |
| 100 | 90 | - Update web-page svn with new download links (to be published *after* release) | |
| 101 | 91 | ||
| 102 | 92 | #### Release (At day 14 to 16) | |
| 103 | 93 | ||
| 104 | 94 | - Make files public on Sourceforge (un-stage) | |
| 105 | 95 | - Set files as current release | |
| 106 | 96 | ||
| 107 | - | ||
| 97 | + | - Public announcement of Release | |
| 108 | 98 | ||
| 109 | 99 | - Forum | |
| 110 | 100 | ||
| 111 | 101 | - Sourceforge news | |
| 112 | 102 | ||
| 113 | 103 | - Update web-page (Download-links / Checksums) | |
| 114 | - | ||
| 115 | - | ||
| 116 | - | ||
| 117 | - | ||
| 118 | - | ||
| 119 | - | ||
| 120 | 104 | ||
| 121 | 105 | ## Merging fixes | |
| 122 | 106 | ||
| 123 | 107 | Team members will add any revision that should be merged to the "fixes branch" page (see "Related Pages"). | |
| 124 | 108 | ||
| 125 | 109 | User can contact Team members | |
| 126 | 110 | ||
| 127 | 111 | - on the forum | |
| 128 | 112 | - on the mail list | |
| 129 | 113 | - on open & assigned mantis reports | |
| 130 | 114 | ||
| 131 | 115 | to request revisions to be added. | |
| 132 | 116 | ||
| 133 | 117 | ## Other Items | |
| 134 | 118 | ||
| 135 | 119 | In addition to the items on the checklist: | |
| 136 | 120 | ||
| 137 | 121 | - create new targets on Mantis, with each RC, and for the Release | |
| 138 | 122 | - Publish checksums on webpage | |
| 139 | 123 | - Update links on webpage | |
| 140 | 124 | - Updating of help files | |
| 141 | 125 | - Announcements for Translators | |
| 142 | 126 | ||
| 143 | 127 | TODO: Decide on channels for public feedback on: | |
| 144 | 128 | ||
| 145 | 129 | - Open regressions | |
| 146 | 130 | - Missing merges | |
| 147 | 131 | ||
| 148 | 132 | ## Checklist (Suggestions) | |
| 149 | 133 | ||
| 150 | 134 | Please add suggestions here. The editing of the Checklist above should be reserved to the team. Thanks. | |
| 151 | 135 | ||
| 152 | 136 | ## How to merge | |
| 153 | 137 | ||
| 154 | 138 | The lazarus developers have decided to use the native svn merge for this branch. Other branches used the svnmerge.py script to manage the revisions to be merged. | |
| 155 | 139 | ||
| 156 | 140 | - TODO: Maybe this information should be put in a separate page. | |
| 157 | 141 | ||
| 158 | 142 | [[SVN Migration|SVN_Migration#Merge_with_plain_svn]] | |
| 159 | 143 | ||
| 160 | 144 | ### Using TortoiseSVN | |
| 161 | 145 | ||
| 162 | 146 | As noted in the link above using TortoiseSVN is more or less self explaining. | |
| 163 | 147 | ||
| 164 | 148 | - TODO: add some screen shots. | |
| 165 | 149 | ||
| 166 | 150 | When committing, in the recent messages a nice commit message is available. | |
| 167 | 151 | ||
| 168 | 152 | Tested with TortoiseSVN 1.7.6, SVN 1.7.4. | |
| 169 | 153 | ||
| 170 | 154 | ### Show list of revision that can be merged | |
| 171 | 155 | ||
| 172 | 156 | In the lazarus fixes_1_0 directory do: | |
| 173 | 157 | ||
| 174 | 158 | `svn mergeinfo ^/trunk --show-revs eligible` | |
| 175 | 159 | ||
| 176 | 160 | Or if you don't have a fixes directory checked out, you can pass the URL path of the fixes branch: | |
| 177 | 161 | ||
| 178 | 162 | `svn mergeinfo ^/trunk `[`http://svn.freepascal.org/svn/lazarus/branches/fixes_1_0`](http://svn.freepascal.org/svn/lazarus/branches/fixes_1_0)` --show-revs eligible` | |
| 179 | 163 | ||
| 180 | 164 | ### Show list of revision that have been merged | |
| 181 | 165 | ||
| 182 | 166 | In the lazarus fixes_1_0 directory do: | |
| 183 | 167 | ||
| 184 | 168 | `svn mergeinfo ^/trunk --show-revs merged` | |
| 185 | 169 | ||
| 186 | 170 | ### Merging revisions from trunk | |
| 187 | 171 | ||
| 188 | 172 | To merge one or more revisions from trunk, use the svn merge command. For example to merge revision 36506 and 36510 use: | |
| 189 | 173 | ||
| 190 | 174 | ` svn merge -c 36506,36510 ^/trunk` | |
| 191 | 175 | ||
| 192 | 176 | To generate a commit log message, use: | |
| 193 | 177 | ||
| 194 | 178 | `svn log ^/trunk -c 36506,36510 > svnmerge-commit-message.txt` | |
| 195 | 179 | ||
| 196 | 180 | Edit svnmerge-commit-message.txt with your favorite text editor and add a first line like: | |
| 197 | 181 | ||
| 198 | 182 | `Merged revision 36506,36510 from /trunk.` | |
| 199 | 183 | ||
| 200 | 184 | Commit this with: | |
| 201 | 185 | ||
| 202 | 186 | `svn commit -F svnmerge-commit-message.txt` | |
| 203 | 187 | ||
| 204 | 188 | ### Blocking a revision to be merged | |
| 205 | 189 | ||
| 206 | 190 | Sometimes you want to block a revision to be merged, i.e. you want to make sure that this revision is never merged to the fixes branch, for example, because it contains a new feature or it contains a version number change not applicable to the fixes branch, but only to trunk. To block revision 36507, use: | |
| 207 | 191 | ||
| 208 | 192 | `svn merge -c 36507 --record-only ^/trunk` | |
| 209 | 193 | ||
| 210 | 194 | Then you can create a log message with: | |
| 211 | 195 | ||
| 212 | 196 | `svn log ^/trunk -c 36507 > svnmerge-commit-message.txt` | |
| 213 | 197 | ||
| 214 | 198 | Edit svnmerge-commit-message.txt with your favorite text editor and add first line like: | |
| 215 | 199 | ||
| 216 | 200 | `Blocked revision 36507 from /trunk` | |
| 217 | 201 | ||
| 218 | 202 | Then commit this change: | |
| 219 | 203 | ||
| 220 | 204 | `svn commit -F svnmerge-commit-message.txt` | |
| 221 | 205 | ||
| 222 | 206 | ## Previous releases | |
| 223 | 207 | ||
| 224 | 208 | - [[Lazarus 0.9.30 todo]] | |
| 225 | 209 | - [[Lazarus 0.9.28 todo]] | |
| 226 | 210 | - [[Detailed Lazarus 0.9.22 todo|Lazarus 0.9.22 todo]] | |
| 227 | 211 | ||
| 228 | 212 | - [[Lazarus 0.9.30.2 release plan]] | |
| 229 | 213 | - [[Lazarus 0.9.28.2 release plan]] | |
| 230 | 214 | ||
| 231 | 215 | ## See also | |
| 232 | 216 | ||
| 233 | 217 | - [[Detailed Lazarus release template todo]] | |
| 234 | 218 | ||
| 235 | 219 | ## Related pages | |
| 236 | 220 | ||
| 237 | 221 | --- | |
| 238 | 222 | *From the Free Pascal wiki, page "Lazarus release engineering", as it stood on 2022-08-16 after a change by Skalogryz, 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).* | |
| 239 | 223 | Category: Development | |
| 240 | 224 | Category: Lazarus | |
| 241 | 225 | Category: Release engineering | |
| 242 | 226 | Category: SOPs |
