Skip to content

Commit

Permalink
Merge pull request #1 from pkohout/main
Browse files Browse the repository at this point in the history
added github action to generate docs
  • Loading branch information
TarikViehmann authored Jun 17, 2023
2 parents 1d81538 + 3098c2c commit 0f3d17d
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Generate documentation
on:
push:
branches: [ "main" ]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
gen_html_documentaiton:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2 # Required to mount the Github Workspace to a volume
- name: protoc-gen-doc
uses: addnab/docker-run-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
registry: gcr.io
image: pseudomuto/protoc-gen-doc
options: -v ${{ github.workspace }}:/protos -v ${{ github.workspace }}/docs:/out
run: |
echo "Running generation"
"./entrypoint.sh"
echo "Finished generation"
- name: Upload artifact for pages
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: ${{ github.workspace }}/docs
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit 0f3d17d

Please sign in to comment.