Skip to content

Commit d3536a8

Browse files
committed
Moved released branch instruction to after step 14
1 parent 4ed745f commit d3536a8

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

TCW/tcw22.xml

Lines changed: 19 additions & 16 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,9 @@
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):
280-
<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>
289-
</item>
276+
<!-- Steps 5 and 6 which instruct on how to merge the release branch into the released branch were originally here, but proved to be too early in the process and have now been moved after step 14 -->
290277
<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/>
278+
repository, <code>git push origin release-X.X.X</code><lb/> and watch Jenkins build P5 for you.<lb/>
292279
This should be the final push for this version, and it will trigger the Jenkins servers
293280
to rebuild the TEI packages. As a reminder, you can find the Jenkins servers here:
294281
<list>
@@ -383,6 +370,22 @@
383370
log in, and click the information button on your new release. Make it the default download for all
384371
operating systems. Now make sure that the main Download button links to your package. </item>
385372

373+
<item><hi rend="bold">Merge the release branch into <code>released</code></hi>. <lb/>
374+
<code>git checkout released</code><lb/>
375+
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code></item>
376+
377+
<item><hi rend="bold">Repeat the steps above for the Stylesheets</hi> (have a stylesheets expert on hand when releasing Stylesheets to help debug problems):
378+
<list type="ordered">
379+
<item>Edit the Stylesheets/VERSION number to the correct release number (usually just
380+
remove the 'a').</item>
381+
<item>Run <code>make log</code> to generate the changelog. Then commit the changes.</item>
382+
<item>Merge the release branch into <code>released</code><lb/>
383+
<code>git checkout released</code><lb/>
384+
<code>git merge --no-ff -m "YOUR COMMIT MESSAGE" release-X.X.X</code>
385+
</item>
386+
</list>
387+
</item>
388+
386389
<item>
387390
<hi rend="bold">Update tags on GitHub</hi><lb/> Every time a new release is made, a
388391
"tag" is created consisting of a pointer to the state of the P5 tree at release time.

0 commit comments

Comments
 (0)