Merge pull request #4 from robocup-logistics/tviehmann/add-qol-info #2
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
| 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 |