ci: skip 'update-cli-screenshots' if no changes #273
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: | |
| - master | |
| jobs: | |
| update-cli-screenshots: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install -U pip poetry | |
| poetry --version | |
| poetry install | |
| - name: Update CLI screenshots | |
| run: | | |
| poetry run python scripts/gen_cli_help_screenshots.py | |
| - name: Commit and push updated CLI screenshots | |
| run: | | |
| git config --global user.name "github-actions[bot]" | |
| git config --global user.email "github-actions[bot]@users.noreply.github.com" | |
| git add docs/images/cli_help | |
| if [[ -n "$(git status --porcelain)" ]]; then | |
| git commit -m "docs(cli/screenshots): update CLI screenshots" -m "[skip ci]" | |
| git push | |
| else | |
| echo "No changes to commit. Skipping." | |
| fi | |
| publish-documentation: | |
| runs-on: ubuntu-latest | |
| needs: update-cli-screenshots | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" | |
| fetch-depth: 0 | |
| - name: Pull latest changes | |
| run: | | |
| git pull origin master | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install -U mkdocs mkdocs-material | |
| - name: Build docs | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| python -m mkdocs build | |
| - name: Generate Sponsors 💖 | |
| uses: JamesIves/github-sponsors-readme-action@v1 | |
| with: | |
| token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }} | |
| file: "docs/README.md" | |
| - name: Push doc to Github Page | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| personal_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./site | |
| user_name: "github-actions[bot]" | |
| user_email: "github-actions[bot]@users.noreply.github.com" |