You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pwndbg/.github/workflows/docs-release.yml

45 lines
1.2 KiB
YAML

name: Stable Release Docs
on:
release:
types: [published]
workflow_dispatch:
jobs:
deploy:
name: Deploy docs for stable release
runs-on: ubuntu-latest
steps:
- name: Only allow running on tag refs
if: ${{ github.ref_type != 'tag' }}
run: |
echo "You must run this workflow in the context of a tag."
exit 1
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install latest uv
uses: astral-sh/setup-uv@v6
with:
version: "latest"
- name: Install dependencies
run: uv sync --group docs
- name: Update docs/index.md with README.md
run: uv run ./scripts/generate-readme.py
- name: Deploy site
run: |
# mike pushes commits to the gh-pages branch
git config --global user.email "doc-bot@pwndbg.re"
git config --global user.name "DocBot"
git fetch --no-tags --prune --depth=1 origin +refs/heads/gh-pages:refs/remotes/origin/gh-pages
uv run --group docs mike deploy \
--update-aliases \
--push \
--remote origin \
${{ github.ref_name }} \
stable