docs/.github/workflows/validate-openapi-check.yml at ec08eb3085642091e29fb4198e1f6fc8652d47ce · github/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
name: Validate OpenAPI Check Docker

# **What it does**: Tests building and running the OpenAPI check Docker container
# **Why we have it**: To ensure the Dockerfile and openapi-check script work correctly
# **Who does it impact**: Docs engineering.

on:
  workflow_dispatch:
  pull_request:
    paths:
      - 'Dockerfile.openapi_decorator'
      - 'src/rest/scripts/openapi-check.ts'
      - 'src/rest/scripts/utils/get-operations.ts'
      - 'src/rest/scripts/utils/operation.ts'
      - 'src/rest/fixtures/openapi-check-fixture.json'
      - 'package.json'
      - 'package-lock.json'
      - 'tsconfig.json'
      # Self-test
      - '.github/workflows/validate-openapi-check.yml'

permissions:
  contents: read

jobs:
  validate-openapi-check:
    runs-on: ubuntu-latest
    if: github.repository == 'github/docs-internal'
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4.0.0

      - name: Build Docker image
        run: |
          docker build -f Dockerfile.openapi_decorator -t openapi-decorator:test .

      - name: Test Docker image with sample OpenAPI file
        run: |
          docker run --rm openapi-decorator:test -f "src/rest/fixtures/openapi-check-fixture.json"

      - name: Test Docker image with multiple OpenAPI files
        run: |
          docker run --rm openapi-decorator:test \
            -f "src/rest/fixtures/openapi-check-fixture.json" \
            "src/rest/fixtures/openapi-check-fixture.json"