Merge branch 'main' into patch-1

Author: Sharra-writes

.github/workflows/sync-codeql-cli.yml

@@ -92,7 +92,7 @@ jobs:
 
           branchCheckout=$(git checkout -b $branchname)
           if [[ ! $? -eq 0 ]]; then
-            echo "Branch $branchname already exists in `github/docs-internal`. Exiting..."
+            echo "Branch $branchname already exists in 'github/docs-internal'. Exiting..."
             exit 0
           fi
           git add .

.github/workflows/sync-openapi.yml

@@ -85,7 +85,7 @@ jobs:
           # If nothing to commit, exit now. It's fine. No orphans.
           changes=$(git diff --name-only | wc -l)
           if [[ $changes -eq 0 ]]; then
-            echo "There are no changes to commit after running `npm run sync-rest` Exiting..."
+            echo "There are no changes to commit after running 'npm run sync-rest'. Exiting..."
             exit 0
           fi
 

.github/workflows/validate-openapi-check.yml

@@ -0,0 +1,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'
+      # In case dependencies change
+      - '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@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
+
+      - 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/data/fpt-2022-11-28/schema.json"
+
+      - name: Test Docker image with multiple OpenAPI files
+        run: |
+          docker run --rm openapi-decorator:test \
+            -f "src/rest/data/fpt-2022-11-28/schema.json" \
+            "src/rest/data/ghec-2022-11-28/schema.json"

Dockerfile.openapi_decorator

@@ -1,6 +1,4 @@
-FROM node:18.15-alpine
-
-RUN apk add --no-cache git python make g++
+FROM node:24-alpine
 
 WORKDIR /openapi-check
 
@@ -10,10 +8,11 @@ USER node
 
 COPY --chown=node:node package.json /openapi-check
 COPY --chown=node:node package-lock.json /openapi-check
+COPY --chown=node:node tsconfig.json /openapi-check
 ADD --chown=node:node src /openapi-check/src
 ADD --chown=node:node content /openapi-check/content
 ADD --chown=node:node data /openapi-check/data
 
 RUN npm ci -D
 
-ENTRYPOINT ["node", "/openapi-check/src/rest/scripts/openapi-check.ts"]
+ENTRYPOINT ["npx", "tsx", "/openapi-check/src/rest/scripts/openapi-check.ts"]