|
7 | 7 | - master |
8 | 8 | paths: |
9 | 9 | - 'docs/**' |
| 10 | + - 'mkdocs.yml' |
10 | 11 | - '.github/workflows/api-docs.yml' |
11 | 12 | workflow_dispatch: |
12 | 13 |
|
13 | 14 | permissions: |
14 | | - contents: read |
15 | 15 | pages: write |
16 | 16 | id-token: write |
17 | 17 |
|
18 | 18 | concurrency: |
19 | 19 | group: pages |
20 | | - cancel-in-progress: true |
| 20 | + cancel-in-progress: false |
21 | 21 |
|
22 | 22 | jobs: |
23 | | - deploy: |
24 | | - name: Deploy to GitHub Pages |
| 23 | + build: |
| 24 | + name: Build Documentation |
25 | 25 | runs-on: ubuntu-latest |
26 | | - environment: |
27 | | - name: github-pages |
28 | | - url: ${{ steps.deployment.outputs.page_url }} |
29 | 26 | steps: |
30 | 27 | - name: Checkout code |
31 | 28 | uses: actions/checkout@v4 |
32 | 29 |
|
33 | | - - name: Setup Ruby |
34 | | - uses: ruby/setup-ruby@v1 |
| 30 | + - name: Set up Python |
| 31 | + uses: actions/setup-python@v5 |
35 | 32 | with: |
36 | | - ruby-version: '3.3' |
37 | | - bundler-cache: true |
38 | | - working-directory: docs |
| 33 | + python-version: '3.x' |
| 34 | + |
| 35 | + - name: Install dependencies |
| 36 | + run: pip install mkdocs-material |
39 | 37 |
|
40 | | - - name: Build site with Jekyll |
41 | | - run: bundle exec jekyll build --source docs --destination _site |
42 | | - env: |
43 | | - JEKYLL_ENV: production |
| 38 | + - name: Build site |
| 39 | + run: mkdocs build --strict |
44 | 40 |
|
45 | | - - name: Upload Pages artifact |
| 41 | + - name: Upload artifact |
46 | 42 | uses: actions/upload-pages-artifact@v3 |
| 43 | + with: |
| 44 | + path: site |
47 | 45 |
|
| 46 | + deploy: |
| 47 | + name: Deploy to GitHub Pages |
| 48 | + needs: build |
| 49 | + runs-on: ubuntu-latest |
| 50 | + environment: |
| 51 | + name: github-pages |
| 52 | + url: ${{ steps.deployment.outputs.page_url }} |
| 53 | + steps: |
48 | 54 | - name: Deploy to GitHub Pages |
49 | 55 | id: deployment |
50 | 56 | uses: actions/deploy-pages@v4 |
51 | | - |
52 | | - - name: Summary |
53 | | - run: | |
54 | | - echo "## Docs Deployed" >> $GITHUB_STEP_SUMMARY |
55 | | - echo "" >> $GITHUB_STEP_SUMMARY |
56 | | - PAGE_URL="${{ steps.deployment.outputs.page_url }}" |
57 | | - echo "Documentation deployed to: $PAGE_URL" >> $GITHUB_STEP_SUMMARY |
0 commit comments