Publish Documentation #3
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: Publish Documentation | |
| on: | |
| push: | |
| branches: ["main"] | |
| 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: | |
| install-mdbook: | |
| environment: | |
| name: github-pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/cache@v4 | |
| continue-on-error: true | |
| id: cache-mdbook | |
| with: | |
| key: mdbook | |
| path: ./cargo/**/* | |
| - if: ${{ steps.cache-mdbook.outputs.cache-hit != 'true' }} | |
| name: Install mdbook | |
| env: | |
| CARGO_HOME: ./cargo | |
| # run: cargo install --locked --force [email protected] [email protected] [email protected] [email protected] [email protected] | |
| run: cargo install --locked --force [email protected] [email protected] [email protected] [email protected] [email protected] | |
| install-tfdocs: | |
| environment: | |
| name: github-pages | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/cache@v4 | |
| id: cache-tfdocs | |
| with: | |
| key: tfdocs | |
| path: ./tfdocs/terraform-docs | |
| - if: ${{ steps.cache-tfdocs.outputs.cache-hit != 'true' }} | |
| name: Install terraform-docs | |
| run: | | |
| go install github.com/terraform-docs/[email protected] | |
| mkdir ./tfdocs; mv `go env GOPATH`/bin/terraform-docs ./tfdocs/ | |
| build-and-deploy: | |
| needs: [install-mdbook, install-tfdocs] | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| continue-on-error: true | |
| with: | |
| key: mdbook | |
| path: ./cargo/**/* | |
| - uses: actions/cache@v4 | |
| with: | |
| key: tfdocs | |
| path: ./tfdocs/terraform-docs | |
| - name: Install mdbook-admonish | |
| shell: bash | |
| env: | |
| CARGO_HOME: ./cargo | |
| run: | | |
| export PATH=${PWD}/cargo/bin:${PATH} | |
| cd docs | |
| mdbook-admonish install | |
| - name: Generate docs | |
| shell: bash | |
| env: | |
| CARGO_HOME: ./cargo | |
| run: | | |
| export PATH=${PWD}/tfdocs:${PWD}/cargo/bin:${PATH} | |
| make mdbuild | |
| touch ./docs/book/.nojekyll | |
| - uses: actions/configure-pages@v3 | |
| - uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: './docs/book' | |
| - uses: actions/deploy-pages@v2 | |
| id: deployment |