git-drs/.github/workflows/pages.yaml at development · calypr/git-drs · 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
name: Publish documentation

on:
  push:
    branches: [main]
    paths:
      - docs/**
      - mkdocs.yml
      - .github/workflows/pages.yaml
  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: Check out repository
        uses: actions/checkout@v4

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

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

      - name: Install documentation builder
        run: python -m pip install mkdocs-material==9.6.14

      - name: Select end-user documentation
        run: |
          mkdir -p .pages-docs
          cp docs/index.md .pages-docs/
          cp docs/quickstart.md .pages-docs/
          cp docs/getting-started.md .pages-docs/
          cp docs/commands.md .pages-docs/
          cp docs/access-method-selection-and-authentication.md .pages-docs/
          cp docs/globus.md .pages-docs/
          cp docs/globus-add-url.md .pages-docs/
          cp docs/pointer-files.md .pages-docs/
          cp docs/adding-s3-files.md .pages-docs/
          cp docs/remove-files.md .pages-docs/
          cp docs/troubleshooting.md .pages-docs/
          cp docs/*.png .pages-docs/

      - name: Build documentation and presentation
        run: |
          npx --yes @marp-team/marp-cli@4.2.3 \
            docs/anvil-terra-poc-presentation.md \
            --html \
            --template bespoke \
            --output .pages-docs/anvil-terra-poc-presentation.html
          mkdocs build --strict
          # Keep the standalone Bespoke document byte-for-byte intact.
          cp .pages-docs/anvil-terra-poc-presentation.html \
            _site/anvil-terra-poc-presentation.html

      - name: Verify presentation artifact
        run: |
          # A Bespoke deck needs its embedded browser runtime for slide paging.
          grep -q '<script' _site/anvil-terra-poc-presentation.html
          grep -q 'bespoke' _site/anvil-terra-poc-presentation.html
          # Guard code-block contrast against Marp's highlighting stylesheet.
          grep -q 'pre code.hljs' _site/anvil-terra-poc-presentation.html

      - name: Upload GitHub 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 GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4