add Re-Pro badge

Author: FMatti

.github/workflows/reproduce.yml

@@ -39,6 +39,24 @@ jobs:
         run: |
           find . -name "${{ env.CODE_FILES }}" -exec sh -c "grep '\- name\:.*' {} | python {}" \;
 
+      - name: Obtain commit hash and time
+        shell: bash
+        run: |
+          echo "sha_short=$(git rev-parse --short "$GITHUB_SHA")" >> "$GITHUB_ENV"
+          echo "build_time=$(date +'%Y-%m-%d at %H:%M:%S UTC')" >> $GITHUB_ENV
+
+      - name: Generate Re-Pro badge
+        run: |
+          echo "\begin{tikzpicture}" > "re-pro-badge.tex"
+          echo "    \draw[black, line width=3pt] (0.1, 0.95) to (\textwidth, 0.95) (0.1, -0.95) to (0.8\textwidth, -0.95);" >> "re-pro-badge.tex"
+          echo "    \fill[white] (0, 1.1) to (1, 1.1) arc (90:-90:1.1) to (0, -1.1);" >> "re-pro-badge.tex"
+          echo "    \fill[black] (1, 0) circle (1);" >> "re-pro-badge.tex"
+          echo "    \draw[white, line width=1pt] (0.35, 0.55) arc(140:-80:0.45) to (1.1, -0.65) to (0.95, -0.65) (0.45, 0.45) arc(140:-110:0.31) to (0.58, -0.65) (1.35, -0.65) arc(270:20:0.35) to (1.35, -0.35) (1.35, -0.51) arc(270:50:0.21) (1.43, -0.65) rectangle (1.57, -0.51);" >> "re-pro-badge.tex"
+          echo "    \node[anchor=west] at (2.1, 0.45) {This document is provably reproducible.};" >> "re-pro-badge.tex"
+          echo "    \node[anchor=west] at (2.3, -0.1) {\small \texttt{> hosted at \url{${{ github.server_url }}/${{ github.repository }}}}};" >> "re-pro-badge.tex"
+          echo "    \node[anchor=west] at (2.3, -0.5) {\small \texttt{> built on ${{ env.build_time }} from \href{${{ github.server_url }}/${{ github.repository }}/tree/${{ env.sha_short }}}{${{ env.sha_short }}}}};" >> "re-pro-badge.tex"
+          echo "\end{tikzpicture}" >> "re-pro-badge.tex"
+
       - name: Compile LaTeX document
         run: |
           pdflatex ${{ env.LATEX_PROJECT }}

README.md

@@ -64,6 +64,7 @@ Unless you are using some extraordinary dependencies or features in your project
 - Ìf the branch you want to run the reproducibility proof on is not called `main`, you'll need to modify the `branches:` key at the top of the `reproduce.yml` file.
 - If your code files or LaTeX project is located in subdirectories, relative imports may not work any longer, hence you'll need to manually specify the working directory by adding  `
   working-directory: [PATH]` below the commands which run the code.
+- Merge if already have other pipelines called `reproduce.yml` [TODO]
 
 ## Example
 
@@ -77,10 +78,19 @@ The `main` branch of this repository (which you are currently viewing) serves as
 
 ## The Re-Pro badge
 
-The Re-Pro badge is the seal of reproducibility which can be displayed in a document. It certifies that a document was indeed produced based on the given commit.
+The Re-Pro badge is the certificate of reproducibility, which you can display in your document. It certifies that a document was indeed produced based on a given state of a source.
 
 [Image of badge]
 
+The badge is automatically generated. You can display it in your `LaTeX` documents by adding the following lines (if necessary):
+
+```[tex]
+\usepackage{tikz}
+\usepackage{hyperref}
+...
+\input{re-pro-badge.tex}
+```
+
 ## Advanced usage
 
 ### Commit and push changes to repository

main.tex

@@ -2,6 +2,8 @@
 
 % Import pgf plots
 \usepackage{pgf}
+\usepackage{tikz}
+\usepackage{hyperref}
 \def\mathdefault#1{#1}
 
 \title{Re-Pro example}
@@ -11,12 +13,20 @@
 
 \maketitle
 
-This is a demonstration project which is provably reproducible. \cite{article2021}
+This is a demonstration project which is provably reproducible.
+It is compatible with BibTeX \cite{article2021}.
+The following plot is generated in Python.
 
 \begin{figure}[ht]
     \centering
     \input{plot.pgf}
-    \caption{Example plot.}
+    \caption{This is an example plot.}
+\end{figure}
+
+Below you can see the Re-Pro badge generated for this project:
+
+\begin{figure}[ht]
+\include{re-pro-badge.tex}
 \end{figure}
 
 \bibliographystyle{acm}

plot.py

@@ -63,6 +63,6 @@ def download_matrix(url, save_path="matrices", save_name=None):
 pc = (u.T @ A)
 
 # Visualize principal components
-plt.figure(figsize=(3, 3))
+plt.figure(figsize=(3, 1.5))
 plt.scatter(pc[0], pc[1], color="#2F455C")
 plt.savefig("plot.pgf", bbox_inches="tight")

re-pro-badge.tex

@@ -0,0 +1,7 @@
+\begin{tikzpicture}
+    \draw[black, line width=3pt] (0.1, 0.95) to (\textwidth, 0.95) (0.1, -0.95) to (0.8\textwidth, -0.95);
+    \fill[white] (0, 1.1) to (1, 1.1) arc (90:-90:1.1) to (0, -1.1);
+    \fill[black] (1, 0) circle (1);
+    \draw[white, line width=1pt] (0.35, 0.55) arc(140:-80:0.45) to (1.1, -0.65) to (0.95, -0.65) (0.45, 0.45) arc(140:-110:0.31) to (0.58, -0.65) (1.35, -0.65) arc(270:20:0.35) to (1.35, -0.35) (1.35, -0.51) arc(270:50:0.21) (1.43, -0.65) rectangle (1.57, -0.51);
+    \node[anchor=west] at (2.3, 0.0) {Re-Pro badge was not generated.};
+\end{tikzpicture}