feature(build): introduce wf to update README gif

Signed-off-by: jonathan zollinger <[email protected]>

.github/workflows/update-README.yml

@@ -0,0 +1,33 @@
+name: Update README gifs
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+jobs:
+  vhs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Load secrets from 1Password
+      uses: 1Password/[email protected]
+      id: OPassword-credentials
+      with:
+        export-env: true
+      env:
+        OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_GHACTIONS_SA_TOKEN }}
+        GITHUB_TOKEN: op://gh/vhs-actions/credential
+    - uses: actions/checkout@v3
+    - uses: charmbracelet/vhs-action@v1
+      with:
+        path: 'src/docs/example.tape'
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      env:
+        GITHUB_TOKEN: ${{ steps.OPassword-credentials.outputs.GITHUB_TOKEN }}
+      with:
+        commit_message: Update generated VHS GIF
+        branch: main
+        commit_user_name: vhs-action 📼
+        commit_user_email: [email protected]
+        commit_author: vhs-action 📼 <[email protected]>
+        file_pattern: '*.gif'

README.md

@@ -6,7 +6,7 @@
 
 Microfetch is an improved version of neofetch written with [micronaut] and built with [graalvm].
 
-![WindowsTerminal_CdOxKQxCBf.gif](src/docs/WindowsTerminal_CdOxKQxCBf.gif)
+![example](src/docs/example.gif)
 
 
 ### Install

src/docs/example.tape

@@ -0,0 +1,12 @@
+
+Output example.gif
+
+Require microfetch
+
+Set FontSize 16
+Set Width 350
+Set Height 550
+
+Type "microfetch" Sleep 500ms  Enter
+
+Sleep 5s