gateway/.github/workflows/docs.yaml at 3f0c5e2718d3a40e834e32efaf1c9d3a67a56466 · envoyproxy/gateway · 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
name: Hugo Docs
on:
  push:
    branches:
    - "main"
    paths:
    - 'site/**'
    - 'tools/make/docs.mk'
  pull_request:
    branches:
    - "main"
    paths:
    - 'site/**'
    - 'tools/make/docs.mk'

permissions:
  contents: read

jobs:
  docs-lint:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
      with:
        ref: ${{ github.event.pull_request.head.sha }}

    - uses: ./tools/github-actions/setup-deps

    - name: Run markdown linter
      run: make lint.markdown

    - name: Check links
      run: make docs docs-check-links

  docs-build:
    runs-on: ubuntu-latest
    needs: docs-lint
    permissions:
      contents: write
    steps:
    - name: Git checkout
      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
      with:
        submodules: true
        ref: ${{ github.event.pull_request.head.sha }}

    - uses: ./tools/github-actions/setup-deps

    - name: Setup Node
      uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020  # v7.0.0
      with:
        node-version-file: site/.nvmrc

    - name: Install Site Dependencies and Build Site
      run: make docs

    # Upload docs for GitHub Pages
    - name: Upload GitHub Pages artifact
      uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9  # v5.0.0
      with:
        # Path of the directory containing the static assets.
        path: site/public
        # Duration after which artifact will expire in days.
        # retention-days: # optional, default is 1

  # This workflow contains a single job called "build"
  docs-publish:
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    needs: docs-build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      deployments: write
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128  # v5.0.0