| 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 |
# Default to 'contents: read', which grants actions to read commits. |
| 6 |
# |
| 7 |
# If any permission is set, any permission not included in the list is |
| 8 |
# implicitly set to "none". |
| 9 |
# |
| 10 |
# see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions |
| 11 |
permissions: |
| 12 |
contents: read |
| 13 |
|
| 14 |
concurrency: |
| 15 |
group: ${{ github.workflow }}-${{ github.ref }} |
| 16 |
cancel-in-progress: true |
| 17 |
|
| 18 |
on: |
| 19 |
push: |
| 20 |
branches: |
| 21 |
- 'main' |
| 22 |
- 'v[0-9]*' |
| 23 |
paths: |
| 24 |
- '.github/workflows/docs-upstream.yml' |
| 25 |
- 'docs/**' |
| 26 |
pull_request: |
| 27 |
paths: |
| 28 |
- '.github/workflows/docs-upstream.yml' |
| 29 |
- 'docs/**' |
| 30 |
|
| 31 |
jobs: |
| 32 |
docs-yaml: |
| 33 |
runs-on: ubuntu-latest |
| 34 |
steps: |
| 35 |
- |
| 36 |
name: Checkout |
| 37 |
uses: actions/checkout@v4 |
| 38 |
- |
| 39 |
name: Upload reference YAML docs |
| 40 |
uses: actions/upload-artifact@v4 |
| 41 |
with: |
| 42 |
name: docs-yaml |
| 43 |
path: docs/reference |
| 44 |
retention-days: 1 |
| 45 |
|
| 46 |
validate: |
| 47 |
uses: docker/docs/.github/workflows/validate-upstream.yml@main |
| 48 |
needs: |
| 49 |
- docs-yaml |
| 50 |
with: |
| 51 |
module-name: docker/compose |