chore: prepare v3.12.0 release (#343) #169
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: Docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - test-docs-generator # for testing | |
| # Update version in installation instructions when new version is released | |
| release: | |
| types: | |
| - released | |
| jobs: | |
| generate-and-deploy: | |
| name: Generate and deploy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout head | |
| uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Go | |
| uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0 | |
| with: | |
| go-version-file: 'go.mod' | |
| - name: Setup Python | |
| uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0 | |
| with: | |
| python-version: "3.10" | |
| - name: Generate documentation | |
| run: make docs | |
| - name: Store generated MkDocs site | |
| uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 | |
| with: | |
| name: mkdocs-site | |
| path: site | |
| retention-days: 7 | |
| - name: Deploy to pages | |
| if: ${{ github.ref_name == 'main' || github.event_name == 'release'}} | |
| uses: JamesIves/github-pages-deploy-action@65b5dfd4f5bcd3a7403bbc2959c144256167464e # 4.5.0 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: site | |
| CLEAN: true |