Merge pull request #162 from umarcor/doit-pages

[doit] add initial doit file; add task DeployToGitHubPages

.github/workflows/Documentation.yml

@@ -93,14 +93,8 @@ jobs:
           NEORV32-SITE-nightly.tar.gz
           pdf/NEORV32*nightly.pdf
 
+    - name: '🐍 Install doit'
+      run: pip install doit
+
     - name: '🚀 Deploy to GitHub-Pages'
-      run: |
-        cd public
-        git init
-        cp ../.git/config ./.git/config
-        touch .nojekyll
-        git add .
-        git config --local user.email "push@gha"
-        git config --local user.name "GHA"
-        git commit -am "update ${{ github.sha }}"
-        git push -u origin +HEAD:gh-pages
+      run: ./do.py DeployToGitHubPages "update ${{ github.sha }}"

.gitignore

@@ -1,3 +1,9 @@
+# doit databases
+/.doit.db.*
+
+# python
+__pycache__
+
 # generated application files
 *.bin
 *.o

do.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+
+# doit
+
+from sys import executable, argv as sys_argv, exit as sys_exit
+from os import environ
+from pathlib import Path
+
+from doit.action import CmdAction
+from doit.cmd_base import ModuleTaskLoader
+from doit.doit_cmd import DoitMain
+
+DOIT_CONFIG = {"verbosity": 2, "action_string_formatting": "both"}
+
+ROOT = Path(__file__).parent
+
+
+def task_DeployToGitHubPages():
+    cwd = str(ROOT / "public")
+    return {
+        "actions": [
+            CmdAction(cmd, cwd=cwd)
+            for cmd in [
+                "git init",
+                "cp ../.git/config ./.git/config",
+                "touch .nojekyll",
+                "git add .",
+                'git config --local user.email "push@gha"',
+                'git config --local user.name "GHA"',
+                "git commit -am '{posargs}'",
+                "git push -u origin +HEAD:gh-pages",
+            ]
+        ],
+        "doc": "Create a clean branch in subdir 'public' and push to branch 'gh-pages'",
+        "pos_arg": "posargs",
+    }
+
+
+if __name__ == '__main__':
+    sys_exit(DoitMain(ModuleTaskLoader(globals())).run(sys_argv[1:]))