GitHub+ADQL: Automatic PDF Preview

[Grégory Mantelet]

Hi DAL,

Just a little notification for whoever is interested in ADQL or, more 
generally, in GitHub+IVOA documents matter.

With the help of James D., Marco M. and Markus D., there is now a PDF 
Preview of the ADQL document generated and provided by the GitHub 
repository (without adding/committing it inside the repository):

https://github.com/ivoa-std/ADQL/releases/download/auto-pdf-preview/ADQL-draft.pdf

This preview is updated automatically each time a PullRequest is merged 
with the ivoa-std/ADQL repository (or more precisely, each time a commit 
is pushed into the master branch). This PDF is not versioned.

As said just above, it is ONLY a preview ; it must NOT be distributed. 
To emphasize this draft status, a watermark has been applied on the 
generated PDF (thanks to the very new ivoatex's task 
`$(DOCNAME)-draft.pdf`).

The URL above never changes. You do not have to remember it either 
because it can be easily got in two ways:
     1. by clicking on the badge "Preview | PDF" at the top of the 
README.md file (immediately visible when going at the root of the 
ivoa-std/ADQL repository <https://github.com/ivoa-std/ADQL>):
     2. by going on the Pre-Release "Auto PDF Preview" 
<https://github.com/ivoa-std/ADQL/releases/tag/auto-pdf-preview> in the 
Releases page of the GitHub repository

Please note that the process described until now to update the ADQL (or 
any IVOA) document on GitHub (i.e. using Issues and PullRequests) does 
not change. The PDF preview is automatically generated and managed by a 
GitHub Workflow.

For the curious ones among you, all the magic is in the file 
.github/workflows/preview.yml 
<https://github.com/ivoa-std/ADQL/blob/master/.github/workflows/preview.yml>. 
It has been made as much generic as possible so that it could be copied 
into an ivoa-std repository for another IVOA document without too many 
modifications (e.g. use a recent version of ivoa-tex, adapt the 
environment variable `doc_name` and eventually adapt the list of 
required dependencies). Of course, it also works with forked repositories.

Cheers,
Grégory


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.ivoa.net/pipermail/dal/attachments/20200518/a2ab7281/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: preview_pdf_badge.png
Type: image/png
Size: 2192 bytes
Desc: not available
URL: <http://mail.ivoa.net/pipermail/dal/attachments/20200518/a2ab7281/attachment.png>