feat: updated ci

lbsekr · Apr 24, 2024 · e11335e · e11335e
1 parent 072009c
commit e11335e
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 9 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -2,7 +2,7 @@ name: Build and publish Typst document
 on: push
 
 jobs:
-  build_typst_documents:
+  build_typst_document:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -13,14 +13,33 @@ jobs:
         uses: lvignoli/typst-action@main
         with:
           source_file: main.typ
+      - name: Set commit based variables 
+        shell: bash
+        if: github.ref_type != 'tag'
+        run: |
+          echo "FINAL_FILE_NAME=${PREFIX}$(git rev-parse --short "$GITHUB_SHA").pdf" >> "$GITHUB_ENV"
+        env:
+            PREFIX: ${{ vars.FILE_NAME_PREFIX || 'main_' }}
+      - name: Set tag based variables 
+        shell: bash
+        if: github.ref_type == 'tag'
+        run: |
+          echo "FINAL_FILE_NAME=${PREFIX}${{ github.ref_name }}.pdf" >> "$GITHUB_ENV"
+        env:
+            PREFIX: ${{ vars.FILE_NAME_PREFIX || 'main_' }}
+      - name: Move output file
+        shell: bash
+        run: |
+          mv main.pdf ${{ env.FINAL_FILE_NAME }}
       - name: Upload as artifact
         uses: actions/upload-artifact@v3
         with:
-          name: main.pdf
-          path: main.pdf
-      # - name: Upload to Discord
-      #   uses: sinshutu/upload-to-discord@master
-      #   env:
-      #     DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
-      #   with:
-      #     args: main.pdf
+          name: ${{ env.FINAL_FILE_NAME }}
+          path: ${{ env.FINAL_FILE_NAME }}
+      - name: Upload to Discord
+        uses: sinshutu/upload-to-discord@master
+        if: vars.DISCORD_WEBHOOK
+        env:
+          DISCORD_WEBHOOK: ${{ vars.DISCORD_WEBHOOK }}
+        with:
+          args: ${{ env.FINAL_FILE_NAME }}
diff --git a/README.md b/README.md
@@ -45,6 +45,18 @@ Für die Referenz der ganzen Werte schaue bitte in der `template.typst` Datei na
 )
 ```
 
+### 4. Optional: Konfiguriere die Github Action
+In diesem Repository befindet sich eine [GitHub Action](./.github/workflows/main.yml), die du zum Bauen deines Dokumentes verwenden kannst. Mit dieser GitHub Action wird dein Dokument bei jedem Push (Commit oder Tag) gebaut und als Artefakt hochgeladen. Optional kannst du dieses auch über eine Discord Webhook in einen Discord Channel schicken lassen.
+
+Kopiere hierfür einfach den .github Ordner dieses Projekts in dein Eigenes.
+
+Du kannst zusätzlich folgende Variablen als Action Variablen konfigurieren.
+
+| Variable         | Default | Beschreibung                                           |
+|------------------|---------|--------------------------------------------------------|
+| FILE_NAME_PREFIX | main_   | Präfix der vor der Versionsinfo angehangen werden soll |
+| DISCORD_WEBHOOK  |         | Discord Webhook URL zum Hochladen des PDFs             |
+
 ## Weitere praktische Tipps
 
 - Praktisches Package für TODO-Notizen oder allgemein Anmerkungen am Seitenrand: [package/drafting](https://typst.app/universe/package/drafting)