Skip to content

Commit cabb0c0

Browse files
TCW 22 update: moved creation of release branch to after step 14. (#18)
* What did I change? * Revert "What did I change?" This reverts commit 8663e65. * Moved released branch instruction to after step 14 * Small updates * corrected new step 6 * Correct typo
1 parent 50ed615 commit cabb0c0

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

TCW/tcw22.xml

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
</sourceDesc>
3434
</fileDesc>
3535
<revisionDesc>
36+
<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>
3637
<change when="2025-01-22" who="#RV">Removed any mentions of Jenkins 3, now defunct.</change>
3738
<change when="2024-11-02" who="#EBB">Clarified where to check on the Vault for the current releases of Stylesheets and Guidelines needed for building the oXygen plugin.
3839
Revised instructions on how to update the table of releases for the GitHub website.</change>
@@ -272,23 +273,20 @@
272273
<hi rend="bold">Note:</hi> Tests may need to be updated after copying the updated p5subset.xml file to the Stylesheets/source directory of the Stylesheets release-X.X.X branch. It is recommended to use <code>make DIFFNOW=0 test</code> as this will generate all the actual results and then compare against the expected results afterwards. Once the actual results are generated, you have to manually compare the expected-results and actual-results folders (both under Stylesheets\Test\) and check through all of the files containing differences.</item>
273274
<item><hi rend="bold">Announce a freeze on pushes to the release branch on the
274275
TEI Technical Council mailing list</hi></item>
275-
<item><hi rend="bold">Merge the release branch into <code>released</code></hi>. <lb/>
276-
<code>git checkout released</code><lb/>
277-
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code></item>
278-
<item><hi rend="bold">Repeat the steps above for the Stylesheets</hi> (have a stylesheets expert on hand
279-
when releasing Stylesheets to help debug problems):
276+
277+
<item><hi rend="bold">Commit your changes to the P5 release branch <code>release-X.X.X</code></hi>. <lb/>
278+
</item>
279+
280+
<item><hi rend="bold">Complete the following steps for the Stylesheets</hi> (have a stylesheets expert on hand to help debug problems):
280281
<list type="ordered">
281-
<item>Edit the Stylesheets/VERSION number to the correct release number (usually just
282-
remove the 'a').</item>
283-
<item>Run <code>make log</code> to generate the changelog. Then commit the changes.</item>
284-
<item>Merge the release branch into <code>released</code><lb/>
285-
<code>git checkout released</code><lb/>
286-
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code>
287-
</item>
288-
</list>
282+
<item>Edit the Stylesheets/VERSION number to the correct release number (usually just
283+
remove the 'a').</item>
284+
<item>Run <code>make log</code> to generate the changelog. Then commit the changes.</item>
285+
</list>
289286
</item>
287+
<!-- Steps 5 and 6 which instruct on how to merge the release branch into the released branch were originally here, but for the Jan 2025 creating the released branch at this point proved to be too early in the process and have now been moved after step 14 -->
290288
<item><hi rend="bold">Push your changes</hi> for both P5 and the Stylesheets to the git
291-
repository, <code>git push origin released</code><lb/> and watch Jenkins build P5 for you.<lb/>
289+
repository, <code>git push origin release-X.X.X</code><lb/> and watch Jenkins build P5 for you.<lb/>
292290
This should be the final push for this version, and it will trigger the Jenkins servers
293291
to rebuild the TEI packages. As a reminder, you can find the Jenkins servers here:
294292
<list>
@@ -383,6 +381,19 @@
383381
log in, and click the information button on your new release. Make it the default download for all
384382
operating systems. Now make sure that the main Download button links to your package. </item>
385383

384+
<item><hi rend="bold">Merge the release branch into <code>released</code></hi>. <lb/>
385+
<code>git checkout released</code><lb/>
386+
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code></item>
387+
388+
<item><hi rend="bold">Repeat the steps above for the Stylesheets</hi>:
389+
<list type="ordered">
390+
<item>Merge the release branch into <code>released</code><lb/>
391+
<code>git checkout released</code><lb/>
392+
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code>
393+
</item>
394+
</list>
395+
</item>
396+
386397
<item>
387398
<hi rend="bold">Update tags on GitHub</hi><lb/> Every time a new release is made, a
388399
"tag" is created consisting of a pointer to the state of the P5 tree at release time.
@@ -417,7 +428,7 @@
417428
Finally, close the current Milestone (do not delete it).</item>
418429

419430
<item><hi rend="bold">Update the Debian Package repository with the new release</hi><lb/>
420-
The TEI Debian packages are regularily created during each Jenkins build.
431+
The TEI Debian packages are regularly created during each Jenkins build.
421432
For each release you need to update the TEI Debian repository at
422433
<ref target="http://packages.tei-c.org/deb/">http://packages.tei-c.org/deb/</ref>
423434
which can be done by simply running <code>ant</code> on the TEI server within the

0 commit comments

Comments
 (0)