Skip to content

Commit 328ca3f

Browse files
dvdksnndeloof
authored andcommitted
add docs upstream validation workflow
verifies that the reference docs don't contain broken links etc Signed-off-by: David Karlsson <[email protected]>
1 parent e1bbfc6 commit 328ca3f

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

.github/workflows/docs-upstream.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# this workflow runs the remote validate bake target from docker/docs
2+
# to check if yaml reference docs used in this repo are valid
3+
name: docs-upstream
4+
5+
concurrency:
6+
group: ${{ github.workflow }}-${{ github.ref }}
7+
cancel-in-progress: true
8+
9+
on:
10+
push:
11+
branches:
12+
- 'main'
13+
- 'v[0-9]*'
14+
paths:
15+
- '.github/workflows/docs-upstream.yml'
16+
- 'docs/**'
17+
pull_request:
18+
paths:
19+
- '.github/workflows/docs-upstream.yml'
20+
- 'docs/**'
21+
22+
jobs:
23+
docs-yaml:
24+
runs-on: ubuntu-22.04
25+
steps:
26+
-
27+
name: Checkout
28+
uses: actions/checkout@v4
29+
-
30+
name: Upload reference YAML docs
31+
uses: actions/upload-artifact@v3
32+
with:
33+
name: docs-yaml
34+
path: docs/reference
35+
retention-days: 1
36+
37+
validate:
38+
uses: docker/docs/.github/workflows/validate-upstream.yml@main
39+
needs:
40+
- docs-yaml
41+
with:
42+
module-name: docker/compose

0 commit comments

Comments
 (0)