Merge pull request #1 from ivoa/20231019-zrq-setup

Setting up GitHub workflows

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+# This file generated from a template file maintained in the ivoatex repository.
+# To create and install it into a project repository, do:
+#    make github-preview
+#    git commit
+#    git push
+#
+name: Check the IVOA document
+
+env:
+  doc_name: CloudTechnologies
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout the repository
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
+
+    - name: Build the document
+      run: make
+
+    - name: Check the output
+      run: |
+        test -f ${{ env.doc_name }}.pdf
+        test -f ${{ env.doc_name }}.bbl
+
+    - name: Keep the PDF artefact
+      uses: actions/upload-artifact@v1
+      with:
+        name: PDF Preview
+        path: ${{ env.doc_name }}.pdf

.github/workflows/preview.yml

@@ -0,0 +1,66 @@
+# This file generated from a template file maintained in the ivoatex repository.
+# To create and install it into a project repository, do:
+#    make github-preview
+#    git commit
+#    git push
+#
+name: Update PDF Preview
+
+env:
+  doc_name: CloudTechnologies
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout the repository
+      uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super
+        sudo snap install pdftk
+
+    - name: Build the document
+      run: make ${{ env.doc_name }}-draft.pdf
+
+    - name: Check the output
+      run: |
+        test -f ${{ env.doc_name }}-draft.pdf
+        test -f ${{ env.doc_name }}.bbl
+
+    - name: Move the auto-pdf-preview tag
+      uses: weareyipyip/walking-tag-action@v2
+      with:
+        tag-name: auto-pdf-preview
+        tag-message: |
+          Last commit taken into account for the automatically updated PDF preview of this IVOA document.
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Update the PDF preview
+      uses: Xotl/cool-github-releases@v1
+      with:
+        mode: update
+        isPrerelease: true
+        tag_name: auto-pdf-preview
+        release_name: "Auto PDF Preview"
+        body_mrkdwn: |
+          This release aims to provide a PDF preview of the last commit applied on this repository.
+          It will be updated automatically after each merge of a PullRequest.
+          **DO NOT PUBLISH THIS PRE-RELEASE!**"
+          _Corresponding commit: ${{ github.sha }}_
+        assets: ${{ env.doc_name }}-draft.pdf
+        replace_assets: true
+        github_token: ${{ secrets.GITHUB_TOKEN }}

CloudTechnologies.tex

@@ -1,27 +1,30 @@
 \documentclass[11pt,a4paper]{ivoa}
 \input tthdefs
 
-\title{???? Full title ????}
+\title{Cloud technologies in the IVOA}
 
 % see ivoatexDoc for what group names to use here; use \ivoagroup[IG] for
 % interest groups.
-\ivoagroup{???? group ????}
+\ivoagroup{GWS}
 
-\author[????URL????]{????Alfred Usher Thor????}
-\author{????Fred Offline????}
+\author[http://www.ivoa.net/twiki/bin/view/IVOA/DaveMorris]
+       {Dave Morris}
+\author{Vicente Navarro}
 
-\editor{????Alfred Usher Thor????}
+\editor[http://www.ivoa.net/twiki/bin/view/IVOA/DaveMorris]
+       {Dave Morris}
 
 % \previousversion[????URL????]{????Concise Document Label????}
 \previousversion{This is the first public release}
 
 
 \begin{document}
 \begin{abstract}
-???? Abstract ????
+An IVOA Note to explore common patterns in the way that we use 'cloud technologies'
+and to develop best practice advice that will foster interoperability between
+different platforms.
 \end{abstract}
 
-
 \section*{Acknowledgments}
 
 ???? Or remove the section header ????
@@ -47,22 +50,22 @@ \section{Introduction}
 
 \subsection{Role within the VO Architecture}
 
-\begin{figure}
-\centering
+%\begin{figure}
+%\centering
 
 % As of ivoatex 1.2, the architecture diagram is generated by ivoatex in
 % SVG; copy ivoatex/archdiag-full.xml to role_diagram.xml and throw out
 % all lines not relevant to your standard.
 % Notes don't generally need this.  If you don't copy role_diagram.xml,
 % you must remove role_diagram.pdf from SOURCES in the Makefile.
 
-\includegraphics[width=0.9\textwidth]{role_diagram.pdf}
-\caption{Architecture diagram for this document}
-\label{fig:archdiag}
-\end{figure}
+%\includegraphics[width=0.9\textwidth]{role_diagram.pdf}
+%\caption{Architecture diagram for this document}
+%\label{fig:archdiag}
+%\end{figure}
 
-Fig.~\ref{fig:archdiag} shows the role this document plays within the
-IVOA architecture \citep{2021ivoa.spec.1101D}.
+%Fig.~\ref{fig:archdiag} shows the role this document plays within the
+%IVOA architecture \citep{2021ivoa.spec.1101D}.
 
 ???? and so on, LaTeX as you know and love it. ????
 

README.md

@@ -1,3 +1,5 @@
+[![PDF-Preview](https://img.shields.io/badge/Preview-PDF-blue)](../../releases/download/auto-pdf-preview/CloudTechnologies-draft.pdf)
+
 An IVOA Note to explore common patterns in the way that we use
 'cloud technologies' and to develop best practice advice
 that will foster interoperability between different platforms.