Skip to content

Commit 1fd1a01

Browse files
committed
Improved: Greatly Expanded Tests in Repository
1 parent 12ce348 commit 1fd1a01

1 file changed

Lines changed: 98 additions & 2 deletions

File tree

.github/workflows/test-mkdocs-workflow.yml

Lines changed: 98 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,104 @@ jobs:
2828
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
2929
submodules: 'recursive'
3030

31-
- name: Deploy MkDocs
31+
- name: Test Default Parameters
3232
uses: Reloaded-Project/devops-mkdocs@v1
3333
with:
34-
requirements: docs/requirements.txt
34+
checkout-current-repo: false
35+
36+
- name: Test Custom MkDocs Version
37+
uses: Reloaded-Project/devops-mkdocs@v1
38+
with:
39+
mkdocs-version: '9.2.0'
40+
checkout-current-repo: false
41+
42+
- name: Test Disable Checkout
43+
uses: Reloaded-Project/devops-mkdocs@v1
44+
with:
45+
checkout-current-repo: false
46+
47+
- name: Create Pre-build Script (Bash)
48+
shell: bash
49+
run: |
50+
echo '#!/bin/bash' > pre-build-bash.sh
51+
echo 'echo "Running pre-build script (Bash)"' >> pre-build-bash.sh
52+
echo 'ls -l' >> pre-build-bash.sh
53+
echo 'touch pre-build-bash-executed.txt' >> pre-build-bash.sh
54+
55+
- name: Test Custom Pre-build Script (Bash)
56+
uses: Reloaded-Project/devops-mkdocs@v1
57+
with:
58+
pre-build-script: pre-build-bash.sh
59+
pre-build-shell: bash
60+
checkout-current-repo: false
61+
62+
- name: Assert Pre-build Script Execution (Bash)
63+
shell: bash
64+
run: |
65+
if [ ! -f pre-build-bash-executed.txt ]; then
66+
echo "Pre-build script (Bash) did not execute successfully"
67+
exit 1
68+
fi
69+
70+
- name: Create Pre-build Script (PowerShell)
71+
shell: pwsh
72+
run: |
73+
echo '#!/usr/bin/env pwsh' > pre-build-pwsh.ps1
74+
echo 'Write-Output "Running pre-build script (PowerShell)"' >> pre-build-pwsh.ps1
75+
echo 'Get-ChildItem' >> pre-build-pwsh.ps1
76+
echo 'New-Item -ItemType File -Path pre-build-pwsh-executed.txt' >> pre-build-pwsh.ps1
77+
78+
- name: Test Custom Pre-build Script (PowerShell)
79+
uses: Reloaded-Project/devops-mkdocs@v1
80+
with:
81+
pre-build-script: pre-build-pwsh.ps1
82+
pre-build-shell: pwsh
83+
checkout-current-repo: false
84+
85+
- name: Assert Pre-build Script Execution (PowerShell)
86+
shell: pwsh
87+
run: |
88+
if (-not (Test-Path -Path pre-build-pwsh-executed.txt)) {
89+
Write-Error "Pre-build script (PowerShell) did not execute successfully"
90+
exit 1
91+
}
92+
93+
- name: Test Custom Output Directory
94+
uses: Reloaded-Project/devops-mkdocs@v1
95+
with:
96+
output-directory: docs/_site
97+
checkout-current-repo: false
98+
99+
- name: Assert Custom Output Directory
100+
shell: bash
101+
run: |
102+
if [ ! -d docs/_site ]; then
103+
echo "Custom output directory does not exist"
104+
exit 1
105+
fi
106+
107+
- name: Copy Custom Requirements File
108+
shell: bash
109+
run: cp docs/requirements.txt docs/custom-requirements.txt
110+
111+
- name: Test Custom Requirements Path
112+
uses: Reloaded-Project/devops-mkdocs@v1
113+
with:
114+
requirements: docs/custom-requirements.txt
115+
checkout-current-repo: false
116+
117+
- name: Copy Custom Config File
118+
shell: bash
119+
run: cp mkdocs.yml docs/custom-mkdocs.yml
120+
121+
- name: Test Custom Config File
122+
uses: Reloaded-Project/devops-mkdocs@v1
123+
with:
124+
config-file: docs/custom-mkdocs.yml
125+
checkout-current-repo: false
126+
127+
- name: Test Publish to Pages
128+
uses: Reloaded-Project/devops-mkdocs@v1
129+
with:
130+
publish-to-pages: true
35131
checkout-current-repo: false

0 commit comments

Comments
 (0)