56 lines
1.4 KiB
YAML
56 lines
1.4 KiB
YAML
|
---
|
||
|
|
name: "Docs: Release to GitHub pages"
|
||
|
|
|
||
|
|
on:
|
||
|
|
workflow_dispatch:
|
||
|
|
push:
|
||
|
|
branches:
|
||
|
|
- main
|
||
|
|
paths:
|
||
|
|
- ".github/workflows/docs-release.yaml"
|
||
|
|
- ".mkdocs.yml"
|
||
|
|
- "docs/**"
|
||
|
|
|
||
|
|
permissions:
|
||
|
|
contents: write
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
release-docs:
|
||
|
|
name: Release documentation
|
||
|
|
runs-on: ubuntu-22.04
|
||
|
|
concurrency:
|
||
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||
|
|
steps:
|
||
|
|
- name: "Generate Short Lived OAuth App Token (ghs_*)"
|
||
|
|
uses: actions/create-github-app-token@v1.9.3
|
||
|
|
id: app-token
|
||
|
|
with:
|
||
|
|
app-id: "${{ secrets.TRUXNELL_APP_ID }}"
|
||
|
|
private-key: "${{ secrets.TRUXNELL_APP_PRIVATE_KEY }}"
|
||
|
|
|
||
|
|
- name: Checkout main branch
|
||
|
|
uses: actions/checkout@v4
|
||
|
|
with:
|
||
|
|
token: ${{ steps.app-token.outputs.token }}
|
||
|
|
fetch-depth: 0
|
||
|
|
|
||
|
|
- uses: actions/setup-python@v5
|
||
|
|
with:
|
||
|
|
python-version: 3.x
|
||
|
|
|
||
|
|
- name: Install requirements
|
||
|
|
run: pip install -r docs/requirements.txt
|
||
|
|
|
||
|
|
- name: Build and publish docs
|
||
|
|
run: mkdocs build -f mkdocs.yml
|
||
|
|
|
||
|
|
- name: Deploy
|
||
|
|
uses: peaceiris/actions-gh-pages@v4.0.0
|
||
|
|
if: ${{ github.ref == 'refs/heads/main' }}
|
||
|
|
with:
|
||
|
|
github_token: ${{ steps.app-token.outputs.token }}
|
||
|
|
publish_dir: ./site
|
||
|
|
destination_dir: docs
|
||
|
|
user_name: "Trux-Bot[bot]"
|
||
|
|
user_email: "Trux-Bot[bot] <19149206+trux-bot[bot]@users.noreply.github.com>"
|