Skip to content

Commit 5e71279

Browse files
committed
docs: keep pages workflow template under docs/ci due token limits
1 parent 639ad3a commit 5e71279

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

docs/ci/docs-pages.workflow.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: docs-${{ github.ref }}
17+
cancel-in-progress: true
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: "3.11"
28+
29+
- name: Install docs dependencies
30+
run: |
31+
python -m pip install --upgrade pip
32+
pip install mkdocs
33+
34+
- name: Build docs
35+
run: mkdocs build --strict
36+
37+
- name: Setup Pages
38+
if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }}
39+
uses: actions/configure-pages@v5
40+
41+
- name: Upload Pages artifact
42+
if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }}
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: site
46+
47+
deploy:
48+
if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }}
49+
needs: build
50+
runs-on: ubuntu-latest
51+
environment:
52+
name: github-pages
53+
url: ${{ steps.deployment.outputs.page_url }}
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)