docs: remove unnecessary words #253
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: Deploy documentation | |
| # GitHub events that triggers the workflow: | |
| on: | |
| push: | |
| branches: ["main"] | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Hatch | |
| uses: pypa/hatch@install | |
| - name: Store cache ID | |
| run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
| - name: Create a key | |
| uses: actions/cache@v4 | |
| with: | |
| key: mkdocs-material-${{ env.cache_id }} | |
| path: .cache | |
| restore-keys: | | |
| mkdocs-material- | |
| - name: Deploy documentation | |
| run: | | |
| hatch run docs:deploy | |
| - name: Update schema.json | |
| run: | | |
| hatch run docs:update-schema | |
| - name: Update `examples` folder | |
| run: | | |
| hatch run docs:update-examples | |
| - name: Update entry figures | |
| run: | | |
| hatch run docs:update-entry-figures | |
| - name: Check if there are changes | |
| uses: dorny/paths-filter@v3 | |
| id: changes | |
| with: | |
| filters: | | |
| schema: | |
| - schema.json | |
| examples: | |
| - examples/*.yaml | |
| entry-figures: | |
| - docs/assets/**/*.png | |
| - name: Update schema.json | |
| if: steps.changes.outputs.schema == 'true' | |
| run: | | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add schema.json | |
| git commit -m "docs: update schema.json" | |
| - name: Update `examples` folder | |
| if: steps.changes.outputs.examples == 'true' | |
| run: | | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add examples/* | |
| git commit -m "docs: update examples" | |
| - name: Update entry figures | |
| if: steps.changes.outputs.entry-figures == 'true' | |
| run: | | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add docs/assets/**/*.png | |
| git commit -m "docs: update entry figures" | |
| - name: Push changes | |
| if: steps.changes.outputs.schema == 'true' || steps.changes.outputs.examples == 'true' || steps.changes.outputs.entry-figures == 'true' | |
| run: | | |
| git push | |