-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation generation and publishing via GitHub Actions
- Loading branch information
1 parent
d60c3f1
commit a8addcb
Showing
2 changed files
with
71 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
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" | ||
-base "/inertia" | ||
-source-link "https://github.com/G-PST/inertia/blob/main/{{.Path}}{{if .Line}}#L{{.Line}}{{end}}" | ||
- name: Fix documentation file permissions | ||
run: | | ||
chmod -c -R +rX "dist/" | while read line; do | ||
echo "::warning title=Invalid file permissions automatically fixed::$line" | ||
done | ||
- name: Setup GitHub Pages | ||
uses: actions/configure-pages@v3 | ||
|
||
- name: Upload docs directory | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
path: "dist" | ||
|
||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters