Skip to content

Commit eac6fc8

Browse files
Sewer56Sewer56
authored
Merge pull request #2 from Reloaded-Project/test-workflow-use-local-action
Changed: Refactor workflow to test local action instead of published version
2 parents ac80bb0 + 5093356 commit eac6fc8

2 files changed

Lines changed: 63 additions & 24 deletions

File tree

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

Lines changed: 51 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ on:
44
schedule:
55
- cron: '0 0 * * *' # Run daily at midnight
66
workflow_dispatch:
7-
push:
8-
branches: [ v1-master ]
9-
tags:
10-
- 'v1'
11-
paths:
12-
- 'action.yml'
13-
- '.github/workflows/test-mkdocs-workflow.yml'
147
pull_request:
158
branches: [ v1-master ]
169
paths:
@@ -24,14 +17,19 @@ jobs:
2417
os: [ubuntu-latest, windows-latest, macos-latest]
2518
runs-on: ${{ matrix.os }}
2619
steps:
20+
- name: Checkout Action Repository
21+
uses: actions/checkout@v4
2722
- name: Checkout Test Repository
2823
uses: actions/checkout@v4
2924
with:
3025
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
3126
submodules: 'recursive'
27+
path: test-project
3228
- name: Test Default Parameters
33-
uses: Reloaded-Project/devops-mkdocs@v1
29+
uses: ./
3430
with:
31+
config-file: test-project/mkdocs.yml
32+
requirements: test-project/docs/requirements.txt
3533
checkout-current-repo: false
3634
publish-to-pages: false
3735

@@ -41,14 +39,19 @@ jobs:
4139
os: [ubuntu-latest, windows-latest, macos-latest]
4240
runs-on: ${{ matrix.os }}
4341
steps:
42+
- name: Checkout Action Repository
43+
uses: actions/checkout@v4
4444
- name: Checkout Test Repository
4545
uses: actions/checkout@v4
4646
with:
4747
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
4848
submodules: 'recursive'
49+
path: test-project
4950
- name: Test Custom MkDocs Version
50-
uses: Reloaded-Project/devops-mkdocs@v1
51+
uses: ./
5152
with:
53+
config-file: test-project/mkdocs.yml
54+
requirements: test-project/docs/requirements.txt
5255
mkdocs-version: '9.5.24'
5356
checkout-current-repo: false
5457
publish-to-pages: false
@@ -59,14 +62,19 @@ jobs:
5962
os: [ubuntu-latest, windows-latest, macos-latest]
6063
runs-on: ${{ matrix.os }}
6164
steps:
65+
- name: Checkout Action Repository
66+
uses: actions/checkout@v4
6267
- name: Checkout Test Repository
6368
uses: actions/checkout@v4
6469
with:
6570
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
6671
submodules: 'recursive'
72+
path: test-project
6773
- name: Test Custom Pre-build Command (Bash)
68-
uses: Reloaded-Project/devops-mkdocs@v1
74+
uses: ./
6975
with:
76+
config-file: test-project/mkdocs.yml
77+
requirements: test-project/docs/requirements.txt
7078
pre-build-command: touch pre-build-bash-executed.txt
7179
pre-build-command-shell: bash
7280
checkout-current-repo: false
@@ -85,14 +93,19 @@ jobs:
8593
os: [ubuntu-latest, windows-latest, macos-latest]
8694
runs-on: ${{ matrix.os }}
8795
steps:
96+
- name: Checkout Action Repository
97+
uses: actions/checkout@v4
8898
- name: Checkout Test Repository
8999
uses: actions/checkout@v4
90100
with:
91101
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
92102
submodules: 'recursive'
103+
path: test-project
93104
- name: Test Custom Pre-build Command (PowerShell)
94-
uses: Reloaded-Project/devops-mkdocs@v1
105+
uses: ./
95106
with:
107+
config-file: test-project/mkdocs.yml
108+
requirements: test-project/docs/requirements.txt
96109
pre-build-command: New-Item -ItemType File -Path pre-build-pwsh-executed.txt
97110
pre-build-command-shell: pwsh
98111
checkout-current-repo: false
@@ -111,14 +124,19 @@ jobs:
111124
os: [ubuntu-latest, windows-latest, macos-latest]
112125
runs-on: ${{ matrix.os }}
113126
steps:
127+
- name: Checkout Action Repository
128+
uses: actions/checkout@v4
114129
- name: Checkout Test Repository
115130
uses: actions/checkout@v4
116131
with:
117132
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
118133
submodules: 'recursive'
134+
path: test-project
119135
- name: Test Custom Output Directory
120-
uses: Reloaded-Project/devops-mkdocs@v1
136+
uses: ./
121137
with:
138+
config-file: test-project/mkdocs.yml
139+
requirements: test-project/docs/requirements.txt
122140
output-directory: custom_site_dir
123141
checkout-current-repo: false
124142
publish-to-pages: false
@@ -136,18 +154,22 @@ jobs:
136154
os: [ubuntu-latest, windows-latest, macos-latest]
137155
runs-on: ${{ matrix.os }}
138156
steps:
157+
- name: Checkout Action Repository
158+
uses: actions/checkout@v4
139159
- name: Checkout Test Repository
140160
uses: actions/checkout@v4
141161
with:
142162
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
143163
submodules: 'recursive'
164+
path: test-project
144165
- name: Copy Custom Requirements File
145166
shell: bash
146-
run: cp docs/requirements.txt docs/custom-requirements.txt
167+
run: cp test-project/docs/requirements.txt test-project/docs/custom-requirements.txt
147168
- name: Test Custom Requirements Path
148-
uses: Reloaded-Project/devops-mkdocs@v1
169+
uses: ./
149170
with:
150-
requirements: docs/custom-requirements.txt
171+
config-file: test-project/mkdocs.yml
172+
requirements: test-project/docs/custom-requirements.txt
151173
checkout-current-repo: false
152174
publish-to-pages: false
153175

@@ -157,18 +179,22 @@ jobs:
157179
os: [ubuntu-latest, windows-latest, macos-latest]
158180
runs-on: ${{ matrix.os }}
159181
steps:
182+
- name: Checkout Action Repository
183+
uses: actions/checkout@v4
160184
- name: Checkout Test Repository
161185
uses: actions/checkout@v4
162186
with:
163187
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
164188
submodules: 'recursive'
189+
path: test-project
165190
- name: Copy Custom Config File
166191
shell: bash
167-
run: cp mkdocs.yml custom-mkdocs.yml
192+
run: cp test-project/mkdocs.yml test-project/custom-mkdocs.yml
168193
- name: Test Custom Config File
169-
uses: Reloaded-Project/devops-mkdocs@v1
194+
uses: ./
170195
with:
171-
config-file: custom-mkdocs.yml
196+
config-file: test-project/custom-mkdocs.yml
197+
requirements: test-project/docs/requirements.txt
172198
checkout-current-repo: false
173199
publish-to-pages: false
174200

@@ -180,13 +206,18 @@ jobs:
180206
pages: write
181207
id-token: write
182208
steps:
209+
- name: Checkout Action Repository
210+
uses: actions/checkout@v4
183211
- name: Checkout Test Repository
184212
uses: actions/checkout@v4
185213
with:
186214
repository: Reloaded-Project/Reloaded.MkDocsMaterial.Themes.R2
187215
submodules: 'recursive'
216+
path: test-project
188217
- name: Test Publish to Pages
189-
uses: Reloaded-Project/devops-mkdocs@v1
218+
uses: ./
190219
with:
220+
config-file: test-project/mkdocs.yml
221+
requirements: test-project/docs/requirements.txt
191222
publish-to-pages: true
192-
checkout-current-repo: false
223+
checkout-current-repo: false

‎action.yml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Build and Deploy MkDocs Material (Reloaded)
22
description: Builds and/or Deploys MkDocs Material to GitHub Pages, or a Directory
33
branding:
4-
icon: 'book'
5-
color: 'red'
4+
icon: "book"
5+
color: "red"
66

77
inputs:
88
mkdocs-version:
@@ -83,7 +83,15 @@ runs:
8383

8484
- name: Build MkDocs Site
8585
shell: bash
86-
run: mkdocs build --config-file "${{ inputs.config-file }}" --site-dir "${{ inputs.output-directory }}"
86+
run: |
87+
# Build to temp location (mkdocs interprets --site-dir relative to config file)
88+
CONFIG_DIR=$(dirname "${{ inputs.config-file }}")
89+
TEMP_DIR="${CONFIG_DIR}/.mkdocs-build-temp"
90+
rm -rf "$TEMP_DIR"
91+
mkdocs build --config-file "${{ inputs.config-file }}" --site-dir ".mkdocs-build-temp"
92+
# Move to user's desired output directory (relative to workspace root)
93+
rm -rf "${{ inputs.output-directory }}"
94+
mv "$TEMP_DIR" "${{ inputs.output-directory }}"
8795
8896
- name: Upload pages artifact
8997
if: ${{ inputs.publish-to-pages == 'true' }}
@@ -97,4 +105,4 @@ runs:
97105
id: deployment
98106
uses: actions/deploy-pages@v4
99107
with:
100-
artifact_name: "github-pages"
108+
artifact_name: "github-pages"

0 commit comments

Comments
 (0)