|
32 | 32 | </sourceDesc> |
33 | 33 | </fileDesc> |
34 | 34 | <revisionDesc> |
| 35 | + <change when="2026-02-18" who="#POC">Add missing links and correct incorrect links in the |
| 36 | + release instructions</change> |
35 | 37 | <change when="2025-09-06" who="#EBB">Added guidance to check links in release notes, including |
36 | 38 | links to latest corrected version of past release notes.</change> |
37 | 39 | <change when="2025-08-27" who="#SDB">Per HBS, move “merge into "released"” steps up to |
|
311 | 313 | target="https://www.tei-c.org/Vault/P5/4.10.2/doc/tei-p5-doc/readme-4.10.0.html" |
312 | 314 | >https://www.tei-c.org/Vault/P5/<hi rend="bold">4.10.2</hi>/doc/tei-p5-doc/<hi |
313 | 315 | rend="bold">readme-4.10.0.html</hi></ref>. </item> |
314 | | - <item><hi rend="bold">Edit the P5/VERSION file to the correct number</hi><lb/> This file |
315 | | - consists only of the bare version number, followed by "alpha" or "beta":<lb/> |
316 | | - <code>2.8.2beta</code><lb/> For the release process, you need to remove the letters from |
| 316 | + <item><hi rend="bold">Edit the P5/VERSION file to the correct number</hi><lb/> Change |
| 317 | + directory to TEI/P5 <code>cd TEI/P5</code>.<lb/> To open the VERSION file, enter |
| 318 | + <code>nano VERSION</code>.<lb/> This file consists only of the bare version number, |
| 319 | + followed by "alpha" or "beta":<lb/> |
| 320 | + <code>2.8.2b</code><lb/> For the release process, you need to remove the letters from |
317 | 321 | the end, leaving a pure version number:<lb/> |
318 | 322 | <code>2.8.2</code><lb/> This changes the release from beta (or possibly alpha) to the |
319 | | - actual release version number. </item> |
| 323 | + actual release version number.<lb/> Save your changes to the VERSION file using the |
| 324 | + keyboard keys <code>Ctrl + S</code>.<lb/> Exit the file using the keyboard keys |
| 325 | + <code>Ctrl + X</code>.<lb/> Commit your changes with the command <code>git commit -a |
| 326 | + -m "Update VERSION number"</code>.<lb/> Push your changes with the command <code>git |
| 327 | + push</code>.<lb/> |
| 328 | + </item> |
320 | 329 |
|
321 | 330 | <!-- MDH and SB: Adding a new step to update p5subset.xml in the Stylesheets repo. --> |
322 | 331 | <item><hi rend="bold">Get p5subset.xml</hi> from a fresh build of the P5 release branch |
|
339 | 348 | </item> |
340 | 349 |
|
341 | 350 | <item><hi rend="bold">Complete the following steps for the Stylesheets</hi> (have a |
342 | | - stylesheets expert on hand to help debug problems): <list type="ordered"> |
| 351 | + stylesheets expert on hand to help debug problems):<lb/> |
| 352 | + <list type="ordered"> |
343 | 353 | <item>Edit the Stylesheets/VERSION number to the correct release number (usually just |
344 | | - remove the 'a').</item> |
| 354 | + remove the 'a'). <lb/> To update the VERSION file, first change directory to the |
| 355 | + Stylesheets. If you are already in the TEI/P5 directory you could change directory |
| 356 | + to the Stylesheets using the following command: <code>cd |
| 357 | + ../../Stylesheets</code><lb/> To open the VERSION file, enter <code>nano |
| 358 | + VERSION</code>.<lb/> Remove the letter at the end and save your changes using the |
| 359 | + keyboard keys <code>Ctrl + S</code>.<lb/> Exit the file using the keyboard keys |
| 360 | + <code>Ctrl + X</code><lb/>. Commit your changes with the command <code>git commit |
| 361 | + -a -m "Update VERSION number"</code>.<lb/> Push your changes with the command |
| 362 | + <code>git push</code><lb/>.</item> |
345 | 363 | <item>Run <code>make log</code> to generate the changelog. Then commit the |
346 | 364 | changes.</item> |
347 | 365 | <item>Merge the release branch into the <code>dev</code> branch<lb/> |
|
416 | 434 | https://raw.githubusercontent.com/TEIC/TEI/dev/P5/Utilities/tei-install.sh -o |
417 | 435 | ~/tei-install.sh</code>. <lb/> (If you'll need to tweak that script later during the |
418 | 436 | install process please make sure to feed the changes back to the original script in the |
419 | | - TEI repo.) <lb/> Do the following three steps: <list type="bulleted"> |
| 437 | + TEI repo.) <lb/>In each of the following steps, <emph>replace the Xs with your release |
| 438 | + version number</emph>. Supply your SourceForge user name, and type your SourceForge |
| 439 | + password when prompted. By default, the script will pull the release package from the |
| 440 | + first Jenkins server, but you can supply the URL of the other server if necessary with |
| 441 | + the --Jenkins parameter, e.g. <code>--Jenkins=http://jenkins2.tei-c.org/</code>. Make |
| 442 | + sure the script completes successfully each time changing the final parameter from |
| 443 | + <code>--install</code>, to <code>--makecurrent</code>, and then <code>--upload</code>. |
| 444 | + <lb/>Following the above guidance, complete these three steps: <list type="bulleted"> |
420 | 445 | <item>Install on tei-c.org: <code>./tei-install.sh --package=TEIP5 --version=X.X.X |
421 | 446 | --sfuser=username --install</code> and then <emph>go test the version this puts in |
422 | 447 | the <ref target="https://www.tei-c.org/Vault/P5/">Vault</ref></emph>.</item> |
|
426 | 451 | <item>If the website looks right then: <code>./tei-install.sh --package=TEIP5 |
427 | 452 | --version=X.X.X --sfuser=username --upload</code> and then move on to the next |
428 | 453 | step.</item> |
429 | | - </list> In each of these steps, replace the Xs with your release version. Supply your |
430 | | - SourceForge user name, and type your SourceForge password when prompted. By default, the |
431 | | - script will pull the release package from the first Jenkins server, but you can supply |
432 | | - the URL of the other server if necessary with the --Jenkins parameter, e.g. |
433 | | - <code>--Jenkins=http://jenkins2.tei-c.org/</code>. Make sure the script completes |
434 | | - successfully each time changing the final parameter from <code>--install</code>, to |
435 | | - <code>--makecurrent</code>, and then <code>--upload</code>. </item> |
| 454 | + </list> |
| 455 | + </item> |
436 | 456 |
|
437 | 457 | <item><hi rend="bold">Repeat the steps above for the Stylesheets</hi>, remembering that |
438 | 458 | the version number is the Stylesheets version, which will be different from the |
439 | | - Guidelines version: <lb/><code>./tei-install.sh --package=Stylesheets --version=X.X.X |
440 | | - --sfuser=username --install</code> |
441 | | - <lb/><code>./tei-install.sh --package=Stylesheets --version=X.X.X --sfuser=username |
442 | | - --makecurrent</code> |
443 | | - <lb/><code>./tei-install.sh --package=Stylesheets --version=X.X.X --sfuser=username |
444 | | - --upload</code> |
445 | | - <lb/> |
| 459 | + Guidelines version: <lb/><list type="bulleted"><item><code>./tei-install.sh --package=Stylesheets --version=X.X.X |
| 460 | + --sfuser=username --install</code> and then <emph>go test the version this puts in |
| 461 | + the <ref target="https://www.tei-c.org/Vault/stylesheets/">Vault</ref></emph>.</item> |
| 462 | + <lb/><item>If that looks good and everyone agrees then:<code>./tei-install.sh --package=Stylesheets --version=X.X.X --sfuser=username |
| 463 | + --makecurrent</code> and then |
| 464 | + <emph>test that it appears on website correctly</emph>.</item> |
| 465 | + <lb/><item>If the website looks right then: <code>./tei-install.sh --package=Stylesheets --version=X.X.X --sfuser=username |
| 466 | + --upload</code></item> |
| 467 | + <lb/></list> |
446 | 468 | </item> |
447 | 469 |
|
448 | 470 | <item><hi rend="bold">Check the TEI website and all downloadable files are displaying the |
|
500 | 522 | target="https://jenkins.tei-c.org/job/TEIP5/lastSuccessfulBuild/artifact/P5/" |
501 | 523 | >https://jenkins.tei-c.org/job/TEIP5/lastSuccessfulBuild/artifact/P5/</ref> and then |
502 | 524 | uploading it to the release page.<lb/> Do the same for the Stylesheets as well. Go to |
503 | | - the Stylesheets Tags page at <ref target="https://github.com/TEIC/TEI/tags" |
| 525 | + the Stylesheets Tags page at <ref target="https://github.com/TEIC/Stylesheets/tags" |
504 | 526 | >https://github.com/TEIC/Stylesheets/tags</ref> on GitHub and follow the same |
505 | | - procedure. </item> |
| 527 | + procedure. Be sure to add a copy of the zipped release by downloading it from <ref |
| 528 | + target="https://jenkins.tei-c.org/job/Stylesheets/lastSuccessfulBuild/artifact/" |
| 529 | + >https://jenkins.tei-c.org/job/Stylesheets/lastSuccessfulBuild/artifact/</ref> and then |
| 530 | + uploading it to the release page. </item> |
506 | 531 |
|
507 | 532 | <item><hi rend="bold">Close/Add GitHub Milestones</hi><lb/> Go to the Milestones page of |
508 | 533 | both the <ref target="https://github.com/TEIC/Stylesheets/milestones">Stylesheets</ref> |
|
0 commit comments