Skip to content

Commit 28ab034

Browse files
committed
guidance on checking links in release notes, especially to corrections of previous release notes
1 parent 20033ec commit 28ab034

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

TCW/tcw22.xml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
</sourceDesc>
3333
</fileDesc>
3434
<revisionDesc>
35+
<change when="2025-09-06" who="#EBB">Added guidance to check links in release notes, including links to latest corrected version of past release notes.</change>
3536
<change when="2025-08-27" who="#SDB">Per HBS, move “merge into "released"” steps up to immediately after the push into the "release-X.X.X" step.</change>
3637
<change when="2025-03-31" who="#POC">Revised and updated procedure as some checking steps are currently listed after the released branch is created. Moved steps 6 and 7 to after step 14.</change>
3738
<change when="2025-01-22" who="#RV">Removed any mentions of Jenkins 3, now defunct.</change>
@@ -258,7 +259,12 @@
258259
<code>git pull origin</code> (to make sure your copy knows about the release branch)<lb/>
259260
<code>git checkout --track origin/release-X.X.X</code>
260261
</item>
261-
<item>Check the release notes for typos or other glaring errors, one last time.</item>
262+
<item>Check the release notes for typos, link issues, or other glaring errors, one last time. If the current release notes
263+
mention revision of past release notes, check that the link URL is pointing to the current release in the Vault,
264+
which contains the full collection of release notes. For example, for a revision to release notes in 4.10.0 in release 4.10.2,
265+
the URL should be:
266+
<ref target="https://www.tei-c.org/Vault/P5/4.10.2/doc/tei-p5-doc/readme-4.10.0.html">https://www.tei-c.org/Vault/P5/<hi rend="bold">4.10.2</hi>/doc/tei-p5-doc/<hi rend="bold">readme-4.10.0.html</hi></ref>.
267+
</item>
262268
<item><hi rend="bold">Edit the P5/VERSION file to the correct number</hi><lb/> This file
263269
consists only of the bare version number, followed by "alpha" or "beta":<lb/>
264270
<code>2.8.2beta</code><lb/> For the release process, you need to remove the letters from

0 commit comments

Comments
 (0)