Postman-PyPNMApps-API/.github/workflows/mkdocs-pages-deploy.yml at main · PyPNMApps/Postman-PyPNMApps-API · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
name: MkDocs Pages Deploy

on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip setuptools wheel
          python -m pip install -e ".[dev]"

      - name: Validate visual sanitization
        run: python tools/sanitize.py --check

      - name: Validate Postman visualizer sync
        run: python tools/postman/sync_visualizers.py --check

      - name: Generate visual docs from visual source of truth
        run: python tools/docs/build_visual_docs.py

      - name: Validate generated visual docs
        run: python tools/docs/build_visual_docs.py --check

      - name: Run tests
        run: python -m pytest -q

      - name: Build MkDocs site
        run: mkdocs build --strict

      - name: Configure GitHub Pages
        uses: actions/configure-pages@v5

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site/

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4