Skip to content

Commit f3fd008

Browse files
committed
Some clarifications by @sydb & @martindholmes during emergency patch release 4.10.1
1 parent c4e766b commit f3fd008

File tree

1 file changed

+39
-18
lines changed

1 file changed

+39
-18
lines changed

TCW/tcw22.xml

Lines changed: 39 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,17 @@
463463
will do.-->
464464
</item>
465465

466-
<item><hi rend="bold">Update the table of previous releases of P5 in the GitHub repo for the TEI-C website</hi>. The table is found in the src/guidelines/p5 markdown page,
467-
published at <ref target="https://tei-c.org/guidelines/p5/#releases">https://tei-c.org/guidelines/p5</ref>.<lb/>
468-
Add the new release information and links to the top of the release table.</item>
466+
<item>
467+
<hi rend="bold">Update the table of previous releases of P5 in the GitHub repo for the TEI-C website</hi>.
468+
The table is found in the <q>src/guidelines/p5.md</q> file
469+
in the <q>website</q> repository; it is published at <ref
470+
target="https://tei-c.org/guidelines/p5/#releases">https://tei-c.org/guidelines/p5</ref>.
471+
<lb/>Add the new release information and links to the top
472+
of the release table.</item>
469473

470-
<item><hi rend="bold">Update the oXygen-ready distribution of TEI.</hi><lb/> This involves
474+
<item><hi rend="bold">Update the oXygen-ready distribution of TEI.</hi>
475+
<lb/>
476+
This involves
471477
building the new package of oxygen-tei, and then updating the distribution file on the
472478
TEI server so that the oXygen software knows about the new release. You may request to
473479
hand this off to one of the maintainers (currently Syd Bauman, James Cummings, or Martin
@@ -490,27 +496,42 @@
490496
target="https://github.com/TEIC/oxygen-tei"
491497
>https://github.com/TEIC/oxygen-tei</ref> to your local system.</item>
492498

493-
<item>cd into the oxygen-tei folder (it should contain folders called "frameworks" and
494-
"jenkins").</item>
499+
<item>cd into the ./oxygen-tei/ folder (it should contain folders called frameworks/ and
500+
jenkins/).</item>
495501

496-
<item>Run the ant build process with the "release" parameter: <lb/>
497-
<code>ant release</code><lb/> This builds the plugin using the latest stable
498-
versions of P5 and the Stylesheets, then offers to upload the result to the TEI's
499-
SourceForge repo to become a release of the TEI-maintained version of the plugin.
500-
This also creates an updated updateSite.oxygen file, by retrieving the latest
501-
updateSite.oxygen file from the tei-c.org site, and asks the user to provide the new
502-
version number before creating a new version of updateSite.oxygen. </item>
502+
<item>Run the ant build process with the "release" parameter:
503+
<lb/><code>ant release</code>
504+
<lb/>This builds the plugin using the latest stable
505+
versions of P5 and the Stylesheets, then offers to
506+
upload the result to the TEI’s SourceForge repo to
507+
become a release of the TEI-maintained version of the
508+
plugin. This also creates an updated updateSite.oxygen
509+
file, by retrieving the latest updateSite.oxygen file
510+
from the tei-c.org site, and asks the user to provide
511+
the new version number before creating a new version of
512+
updateSite.oxygen.</item>
503513

504-
<item>Go to the GitHub repo and create a new release, using the <code>Draft new release</code>
505-
button. Copy the previous release info (tag, title and text), and tweak the versions as appropriate. The tag should be <code>vx.x.x</code>, the title will be
506-
<code>Release x.x.x</code>, and the text <quote>Release number X of the oXygen TEI plugin, based on TEI P5 x.x.x and Stylesheets x.x.x.</quote></item>
514+
<item>Go to the TEI-C/oxygen-tei GitHub repo and create
515+
a new release, using the <code>Draft new release</code>
516+
button. Copy the previous release info (tag, title and
517+
text), and tweak the versions as appropriate. The tag
518+
should be <code>vx.x.x</code>, the title will be
519+
<code>Release x.x.x</code>, and the text <quote>Release
520+
number X of the oXygen TEI plugin, based on TEI P5 x.x.x
521+
and Stylesheets x.x.x.</quote></item>
507522

508523
<item>Attach the zip file you just created in the build process, which will be named
509524
something like <code>oxygen-tei-x.x.x-x.x.x.zip</code>, with the numbers from
510525
the current TEI and Stylesheets releases.</item>
511526

512-
<item>Once the tag/release has been published, run <lb/><code>ant uploadOxygenUpdateFile</code><lb/>
513-
to push the <code>updateSite.oxygen</code> file up to the TEI server.</item>
527+
<item>Once the tag/release has been published, run
528+
<lb/><code>ant uploadOxygenUpdateFile</code> <lb/>to
529+
push the <code>updateSite.oxygen</code> file up to the
530+
TEI server. To check that this has worked, you can look
531+
at the last <code>&lt;xt:extension></code> element in
532+
<ref
533+
target="https://www.tei-c.org/Vault/P5/current/oxygen/updateSite.oxygen">the
534+
XML file on the web</ref>.</item>
514535
</list>
515536
</item>
516537

0 commit comments

Comments
 (0)