Add documentation generation and publishing via GitHub Actions

.github/workflows/docs.yml

@@ -0,0 +1,63 @@
+name: Generate and publish documentation
+
+on:
+ push:
+ branches: [ "main" ]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
+jobs:
+
+ test:
+ uses: ./.github/workflows/tests.yml
+
+ gen-docs:
+ needs: test
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ steps:
+
+ - name: Check out inertia
+ uses: actions/checkout@v3
+
+ - name: Install Go
+ uses: actions/setup-go@v4
+ with:
+ go-version: '1.19'
+
+ - name: Install docs generator
+ run: go install github.com/johnstarich/go/gopages@latest
+
+ - name: Generate documentation
+ run: gopages \
+ -brand-title "inertia" \
+ -brand-description "G-PST Inertia Monitoring Framework Documentation" \
+ -source-link "https://github.com/G-PST/inertia/blob/main/{{.Path}}{{if .Line}}#L{{.Line}}{{end}}" \
+ -out "docs"
+
+ - name: Setup GitHub Pages
+ uses: actions/configure-pages@v3
+
+ - name: Upload docs directory
+ uses: actions/upload-pages-artifact@v2
+ with:
+ path: "docs"
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v2

.github/workflows/tests.yml

@@ -1,10 +1,9 @@
 name: Build and test package
 
 on:
- push:
- branches: [ "main" ]
  pull_request:
  branches: [ "main" ]
+ workflow_call:
 
 jobs:
  run-tests: