Skip to content
Publish documentation

docs(writing_commits): improve documentation for writing commits best… #577

Sign in to view logs

docs(writing_commits): improve documentation for writing commits best…

docs(writing_commits): improve documentation for writing commits best… #577

Workflow file for this run

.github/workflows/docspublish.yml at 77ab109
name: Publish documentation
on:
push:
branches:
- master
workflow_dispatch:
jobs:
update-cli-screenshots:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
fetch-depth: 0
- name: Set up Python
uses: astral-sh/setup-uv@v7
- name: Install dependencies
run: |
uv --version
uv sync --locked --group script
- name: Update CLI screenshots
run: |
uv run poe doc:screenshots
- 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@v6
with:
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
fetch-depth: 0
- name: Pull latest changes
run: |
git pull origin master
- name: Set up Python
uses: astral-sh/setup-uv@v7
- name: Install dependencies
run: |
uv --version
uv sync --locked --only-group documentation
- name: Generate Sponsors 💖
uses: JamesIves/github-sponsors-readme-action@v1
with:
token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }}
file: "docs/README.md"
organization: true
- name: Build docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
uv run poe doc:build
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./site # The folder the action should deploy.
branch: gh-pages