From 93137e785f1c717bf1da6c69ab7920f90c4bbdc4 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Fri, 20 Oct 2023 21:43:42 +0200 Subject: [PATCH] add docs upstream validation workflow verifies that the reference docs don't contain broken links etc Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- .github/workflows/docs-upstream.yml | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/docs-upstream.yml diff --git a/.github/workflows/docs-upstream.yml b/.github/workflows/docs-upstream.yml new file mode 100644 index 0000000000..86d23ab7de --- /dev/null +++ b/.github/workflows/docs-upstream.yml @@ -0,0 +1,42 @@ +# this workflow runs the remote validate bake target from docker/docs +# to check if yaml reference docs used in this repo are valid +name: docs-upstream + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +on: + push: + branches: + - 'main' + - 'v[0-9]*' + paths: + - '.github/workflows/docs-upstream.yml' + - 'docs/**' + pull_request: + paths: + - '.github/workflows/docs-upstream.yml' + - 'docs/**' + +jobs: + docs-yaml: + runs-on: ubuntu-22.04 + steps: + - + name: Checkout + uses: actions/checkout@v4 + - + name: Upload reference YAML docs + uses: actions/upload-artifact@v3 + with: + name: docs-yaml + path: docs/reference + retention-days: 1 + + validate: + uses: docker/docs/.github/workflows/validate-upstream.yml@main + needs: + - docs-yaml + with: + module-name: docker/compose