devops-mkdocs/.github/workflows/test-mkdocs-workflow.yml at 643c01e4b5253e3046cdeb16a243ad4bdd1cf9cc · Reloaded-Project/devops-mkdocs · 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
name: Test MkDocs Workflow

on:
  schedule:
    - cron: '0 0 * * *' # Run daily at midnight
  workflow_dispatch:
  pull_request:
    branches: [ v1-master ]
    paths:
      - 'action.yml'
      - '.github/workflows/test-mkdocs-workflow.yml'

jobs:
  test-default-parameters:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Default Parameters
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          checkout-current-repo: false
          publish-to-pages: false

  test-custom-mkdocs-version:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Custom MkDocs Version
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          mkdocs-version: '9.5.24'
          checkout-current-repo: false
          publish-to-pages: false

  test-custom-pre-build-command-bash:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Custom Pre-build Command (Bash)
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          pre-build-command: touch pre-build-bash-executed.txt
          pre-build-command-shell: bash
          checkout-current-repo: false
          publish-to-pages: false
      - name: Assert Pre-build Command Execution (Bash)
        shell: bash
        run: |
          if [ ! -f pre-build-bash-executed.txt ]; then
            echo "Pre-build command (Bash) did not execute successfully"
            exit 1
          fi

  test-custom-pre-build-command-pwsh:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Custom Pre-build Command (PowerShell)
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          pre-build-command: New-Item -ItemType File -Path pre-build-pwsh-executed.txt
          pre-build-command-shell: pwsh
          checkout-current-repo: false
          publish-to-pages: false
      - name: Assert Pre-build Command Execution (PowerShell)
        shell: pwsh
        run: |
          if (-not (Test-Path -Path pre-build-pwsh-executed.txt)) {
            Write-Error "Pre-build command (PowerShell) did not execute successfully"
            exit 1
          }

  test-custom-output-directory:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Custom Output Directory
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          output-directory: custom_site_dir
          checkout-current-repo: false
          publish-to-pages: false
      - name: Assert Custom Output Directory
        shell: bash
        run: |
          if [ ! -d custom_site_dir ] || [ -z "$(ls -A custom_site_dir)" ]; then
            echo "Custom output directory does not exist or is empty"
            exit 1
          fi

  test-custom-requirements-path:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Copy Custom Requirements File
        shell: bash
        run: cp test-project/docs/requirements.txt test-project/docs/custom-requirements.txt
      - name: Test Custom Requirements Path
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/custom-requirements.txt
          checkout-current-repo: false
          publish-to-pages: false

  test-custom-config-file:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Copy Custom Config File
        shell: bash
        run: cp test-project/mkdocs.yml test-project/custom-mkdocs.yml
      - name: Test Custom Config File
        uses: ./
        with:
          config-file: test-project/custom-mkdocs.yml
          requirements: test-project/docs/requirements.txt
          checkout-current-repo: false
          publish-to-pages: false

  test-publish-to-pages:
    # This can only be ran on a single OS, due to artifact name conflict.
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - name: Checkout Action Repository
        uses: actions/checkout@v6
      - name: Checkout Test Repository
        uses: actions/checkout@v6
        with:
          repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
          submodules: 'recursive'
          path: test-project
      - name: Test Publish to Pages
        uses: ./
        with:
          config-file: test-project/mkdocs.yml
          requirements: test-project/docs/requirements.txt
          publish-to-pages: true
          checkout-current-repo: false