Deploy SMLM lab manual on tag

kmdouglass · Aug 8, 2023 · 268104c · 268104c
1 parent 4661a08
commit 268104c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/.github/workflows/build-smlm-course-manual.yml b/.github/workflows/build-smlm-course-manual.yml
@@ -1,5 +1,10 @@
 name: Build SMLM Course Manual
-on: [push]
+
+on:
+    push:
+      tags:
+      - 'smlm-lab-manual-*'
+
 jobs:
   build_latex:
     runs-on: ubuntu-latest
@@ -14,5 +19,5 @@ jobs:
       - name: Upload PDF file
         uses: actions/upload-artifact@v3
         with:
-          name: PDF
+          name: smlm-lab-manual
           path: texts/smlm-lab-course/smlm-lab-manual.pdf
diff --git a/texts/smlm-lab-course/README.md b/texts/smlm-lab-course/README.md
@@ -2,6 +2,13 @@
 
 Laboratory manual for the SMLM course as part of the Travaux Pratiques de Physique at EPFL.
 
+## Compile and deploy the manual to GitHub
+
+```console
+git tag smlm-lab-manual-YYYY-MM-DD
+git push --tags
+```
+
 ## Build the manual
 
 ### Docker