Website publish automation #1
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: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| jobs: | |
| diff: | |
| runs-on: [ubuntu-latest] | |
| outputs: | |
| isDoc: ${{ steps.diff.outputs.isDoc }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Detect Changes | |
| uses: "./.github/actions/diffs" | |
| id: diff | |
| spelling: | |
| name: Lint documentation | |
| needs: diff | |
| if: needs.diff.outputs.isDoc == 'true' | |
| runs-on: [ubuntu-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Spell Check Docs | |
| uses: crate-ci/typos@master | |
| with: | |
| files: ./doc ./*.md | |
| deploy: | |
| runs-on: ubuntu-latest | |
| if: github.event.repository.fork == false | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - run: pip install mkdocs-material | |
| - run: pip install mkdocs-git-revision-date-localized-plugin | |
| - run: pip install mkdocs-minify-plugin | |
| - run: mkdocs gh-deploy --force |