Merge pull request #1 from certtools/publish

make branch

Author: aaronkaplan

.github/workflows/mkdcs.yml

@@ -36,6 +36,11 @@ jobs:
         run: |
           pip install mkdocs-material mike lunr pygments mkdocstrings[python] mkdocs-material mkdocs-glightbox mkdocs-redirects mkdocs-minify-plugin ruamel.yaml
 
+      - name: "Prepare git"
+        run: |
+          git fetch origin gh-pages --depth=1
+          git config user.name defo-security-analysis-bot
+          git config user.email defo-security-analysis-bot
 
       - name: "Build docs without publishing"
         if: github.event_name == 'pull_request'

README.md

@@ -38,6 +38,8 @@ cd report
 mkdocs serve
 ```
 
+Note well: we publish the documentation under github pages.
+
 ## Table of contents
 
 - [Overview what we are going to analyse](analysis_plan.md)