Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ”¨ Adds a GH workflow automation to sync docs to docs site

Alicia Sykes0229ad6a76e6
diff --git a/.github/workflows/update-docs-site.yml b/.github/workflows/update-docs-site.yml
new file mode 100644
index 00000000..58e64330
--- /dev/null
+++ b/.github/workflows/update-docs-site.yml
@@ -0,0 +1,57 @@
+name: πŸ“ Update Documentation
+
+# This will run whenever the /docs directory in master branch is updated,
+# or if the workflow is manually dispatched, plus a sync check on Sun at 03:30 UTC
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: '30 3 * * 0'
+ push:
+ branches:
+ - master
+ paths:
+ - 'docs/**'
+
+
+# Jobs to be run:
+# 1. Checkout master branch
+# 2. Checkout website source code branch
+# 3. Install Python
+# 4. Run the script which processes documentation
+# 5. Commit and push updated docs to the website source code branch
+jobs:
+ update-docs:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout master branch πŸ›ŽοΈ
+ uses: actions/checkout@v2
+ with:
+ path: 'master-docs'
+
+ - name: Checkout WEBSITE/docs-site-source branch πŸ›ŽοΈ
+ uses: actions/checkout@v2
+ with:
+ ref: 'WEBSITE/docs-site-source'
+ path: 'website-docs'
+
+ - name: Install Python 🐍
+ uses: actions/setup-python@v2
+ with:
+ python-version: '3.x'
+
+ - name: Run script to update documentation πŸͺ„
+ run: |
+ cp -r master-docs/docs website-docs/docs
+ python website-docs/do-markdown-magic.py
+ working-directory: website-docs
+
+ - name: Commit changes πŸš€
+ run: |
+ cd website-docs
+ git config --local user.email "[email protected]"
+ git config --local user.name "Liss-Bot"
+ git add docs
+ git commit -m "Update documentation" || echo "No changes to commit"
+ git push
+ env:
+ GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}