<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body>
Dear IVOA document editors,<br>
<br>
This email concerns only people in charge of an ivoa-std repository
on GitHub.<br>
<b><br>
</b>Whether a PDF preview is automatically generated in your GitHub
repository, or whether you want to set it up, this email is for you.<br>
We encourage you to update your CI configuration thanks to the last
version of the ivoatex's Makefile.<br>
<br>
This update includes the following fixes:<br>
<br>
<ul>
<li>Upgrade the following GitHub actions:</li>
<ul>
<li><font face="monospace">actions/checkout</font> (to checkout
the Git repository in the CI container)</li>
<li><font face="monospace">actions/upload-artifact</font> (to
keep the artifact - the PDF preview - on GitHub for some time)<br>
<br>
</li>
</ul>
<li>Rebuild the steps generating the PDF preview (using simple
standard GitHub CLI commands instead of unofficial and
deprecated GitHub actions)<br>
<br>
</li>
<li>Resolution of the duplicated Draft Releases</li>
<ul>
<li>Problem: each time the CI ran, the former Pre-Release
hosting the PDF preview was transformed into a Draft while
another Pre-Release with the same name is created. Then, all
former Pre-Releases stay available on the GitHub repository as
Drafts instead of being removed ; this generated quickly a lot
of pollution.</li>
<li>Resolved thanks to the full rebuild of the PDF preview
generation<br>
<br>
</li>
</ul>
<li>Add 2 targets in the Makefile:</li>
<ul>
<li><font face="monospace">clear-ci</font> : remove the two
GitHub workflows (build and PDF preview only)</li>
<li><font face="monospace">update-ci</font>: remove existing
GitHub workflows and create them again with the template
workflows available in ivoatex ; this command is exactly the
same as running `<font face="monospace">make clear-ci
github-preview</font>`.<br>
<br>
</li>
</ul>
<li>Update the explanations when configuring the Build workflow<br>
<br>
</li>
<li>Update the dependencies installation (e.g. pdftk seems now to
be available in APT instead of using snap)</li>
</ul>
<br>
Now, here are the instructions to update your workflows:<br>
<br>
<ol>
<li>Update the submodule <font face="monospace">ivoatex</font>:<br>
<br>
<font face="monospace"><font color="#77767b">```bash</font><br>
cd ivoatex/<br>
git checkout master<br>
git pull<br>
cd ..<br>
git add ivoatex/<br>
git commit -m "Update ivoatex"<br>
<font color="#77767b">```</font></font><br>
<br>
</li>
<li>Ensure <font face="monospace">DOCNAME</font> is set in your
repository's Makefile<br>
<br>
</li>
<li>Run the Makefile target <font face="monospace">update-ci</font>:<br>
<br>
<font face="monospace"><font color="#77767b">```bash</font><br>
make update-ci<br>
<font color="#77767b">```</font></font><br>
<br>
</li>
<li>Commit the updated CI<br>
<br>
<font face="monospace"><font color="#77767b">```bash</font><br>
git add .github/workflows/build.yml
.github/workflows/preview.yml<br>
git commit -m "Update CI for build and PDF preview"<br>
<font color="#77767b">```</font></font><br>
<br>
</li>
<li>Push all these modifications<br>
<br>
<font face="monospace"><font color="#77767b">```bash</font><br>
git push<br>
<font color="#77767b">```</font></font><br>
<br>
</li>
<li
style="box-sizing: border-box; margin-top: 0.25em; margin-left: var(--base-size-24);">[Optional]
On the Releases page of your GitHub repositories, manually
remove all (and there may be a lot...sorry) Draft releases (but
not the Pre-Release otherwise you will loose your PDF preview)
named<span> </span><code class="notranslate"
style="box-sizing: border-box; font-family: var(--fontStack-monospace, ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace); font-size: 11.9px; padding: 0.2em 0.4em; margin: 0px; white-space: break-spaces; background-color: var(--bgColor-neutral-muted, var(--color-neutral-muted)); border-radius: 6px;">Auto PDF Preview</code><span> </span>(they
are the unfortunate result of an issue with the former CI
workflow). Thanks to the updated CI, there should be only one<span> </span><code
class="notranslate"
style="box-sizing: border-box; font-family: var(--fontStack-monospace, ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace); font-size: 11.9px; padding: 0.2em 0.4em; margin: 0px; white-space: break-spaces; background-color: var(--bgColor-neutral-muted, var(--color-neutral-muted)); border-radius: 6px;">Auto PDF Preview</code><span> </span>Pre-Release
(and no more Draft with the same name) from now on.</li>
</ol>
<br>
If you have any question, concern, comment or suggestion of
improvement, do not hesitate to contact me (<a
href="mailto:gregory.mantelet@astro.unistra.fr"
class="moz-txt-link-freetext">gregory.mantelet@astro.unistra.fr</a>)
or publish a <a href="https://github.com/ivoa-std/ivoatex/issues">GitHub
issue in ivoa-std/ivoatex repository</a>.<br>
<br>
Cheers,<br>
Grégory M.<br>
<br>
</body>
</html>