Merge branch 'main' into feat-insomnia-postman-feature-comparison-2128

Author: TuannasCodeCatastrophe

.github/copilot-instructions.md

@@ -0,0 +1,18 @@
+This is a docs repository for the Kong Developer site (https://developer.konghq.com/). We use Jekyll, Netlify, Ruby, and then write our docs in Markdown and YAML. Please use these guidelines when you are asked to create a PR, write a commit, or review a PR:
+
+## Required Before Each Commit
+- Run `make run` before committing any changes to ensure there aren't any issues with the site building
+
+## Repository Structure
+- The /tools directory contains all the information about how our different tooling works, such as automated tests, autogenerating new plugin scaffolding, and changelog generator
+
+## PR reviews
+
+When you leave PR reviews, always provide GitHub suggestions with actionable feedback that the PR creator can directly commit. For example, don't say "Change this variable.", instead, create a comment with a suggestion that changes the variable to the correct one.
+
+## Key Guidelines
+- We write three types of docs: reference, landing page (written in yaml), and how-tos
+- When you write or edit a doc, use app/contributing/index.md to format the body text (as well as code blocks) correctly for each page type
+- When writing or editing UI steps, use the formats listed in docs/ui-steps-standards.md
+- When adding tags to the frontmatter, follow the instructions here: docs/update-tag-schema.md
+- For anything that is added to the frontmatter of a doc, use docs/front-matter-reference.md for a reference

.github/reusable-steps/install-deps/action.yaml

@@ -26,7 +26,7 @@ runs:
       run: bundle install --jobs 4 --retry 3
 
     # Configure Node to build assets
-    - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
+    - uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
       with:
         node-version: "22"
 

.github/styles/base/Dictionary.txt

@@ -871,7 +871,7 @@ unescaped
 ungroup
 ungrouped
 Unicode
-Unicode
+unicode
 unix
 unmanaged
 unmarshalled

.github/workflows/check-links-scheduled.yml

@@ -41,7 +41,7 @@ jobs:
         run: bundle install --jobs 4 --retry 3
 
       # Configure Node to build assets
-      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
+      - uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6
         with:
           node-version: "22"
       - name: Cache node modules

.github/workflows/generate-gateway-plugins-changelogs.yml

@@ -12,6 +12,10 @@ on:
         required: true
         default: 'main'
         type: string
+      dev_site_base_branch:
+        description: 'Dev site base branch, e.g. main'
+        required: true
+        type: string
       release_date:
         description: 'Release date for the version (YYYY/MM/DD format). Only used when version is specified.'
         required: true
@@ -46,7 +50,7 @@ jobs:
           token: ${{ steps.app-token.outputs.token }}
 
       - name: Setup Node.js
-        uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
+        uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610 # v3
         with:
           node-version: '18'
           cache: 'npm'
@@ -106,7 +110,7 @@ jobs:
 
       - name: Create pull request
         if: steps.changes.outputs.changed == 'true'
-        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7
+        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
         with:
           title: Generate Gateway and plugins changelogs for version ${{ inputs.version }}
           commit-message: Generate Gateway and plugins changelogs for version ${{ inputs.version }}
@@ -120,6 +124,9 @@ jobs:
           labels: skip-changelog,review:general
           token: ${{ steps.app-token.outputs.token }}
           branch: auto/generate-gateway-plugins-changelogs-${{ github.run_number }}
+          base: ${{ inputs.dev_site_base_branch }}
+          add-paths: |
+            app/**
 
       - name: No changes detected
         if: steps.changes.outputs.changed == 'false'

.github/workflows/generate-kong-conf-json.yml

@@ -0,0 +1,118 @@
+name: Generate Kong Configuration JSON
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Kong version to generate config for (e.g., 3.9)'
+        required: true
+        type: string
+      kong_ee_branch:
+        description: 'Branch to use from kong-ee repository'
+        required: true
+        default: 'main'
+        type: string
+      dev_site_base_branch:
+        description: 'Dev site base branch, e.g. main'
+        required: true
+        type: string
+      kong_conf_path:
+        description: 'Path to kong.conf file in kong-ee repo (relative to repo root)'
+        required: false
+        default: 'kong.conf.default'
+        type: string
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  generate-kong-conf-json:
+    name: Generate Kong Configuration JSON
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@95d9a5deda9de15063e7595e9719c11c38c90ae2 # v2.13.2
+        with:
+          egress-policy: audit
+
+      - name: Create GitHub App Token
+        uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf
+        id: app-token
+        with:
+          app-id: ${{ vars.GH_APP_KONG_DOCS_ID }}
+          private-key: ${{ secrets.GH_APP_KONG_DOCS_SECRET }}
+          owner: Kong
+          
+      - name: Checkout developer.konghq.com
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610 # v3
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: tools/kong-conf-to-json/package-lock.json
+
+      - name: Install kong-conf-to-json dependencies
+        run: |
+          cd tools/kong-conf-to-json
+          npm ci
+
+      - name: Checkout kong-ee repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+        with:
+          repository: 'Kong/kong-ee'
+          token: ${{ steps.app-token.outputs.token }}
+          path: 'kong-ee'
+          ref: ${{ inputs.kong_ee_branch }}
+
+      - name: Create kong-conf data directory
+        run: |
+          mkdir -p app/_data/kong-conf
+
+      - name: Generate kong.conf JSON
+        run: |
+          cd tools/kong-conf-to-json
+          node run.js --file="../../kong-ee/${{ inputs.kong_conf_path }}" --version="${{ inputs.version }}"
+
+      - name: Generate index file
+        run: |
+          cd tools/kong-conf-to-json
+          node index-file.js
+
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create pull request
+        if: steps.changes.outputs.changed == 'true'
+        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
+        with:
+          title: Generate Kong configuration JSON for version ${{ inputs.version }}
+          commit-message: Generate Kong configuration JSON for version ${{ inputs.version }}
+          body: |
+            **Changes:**
+            - Generated JSON representation of kong.conf file
+            - Updated kong-conf index file with version information
+            - Processed Kong version ${{ inputs.version }}
+
+          labels: skip-changelog,review:general
+          token: ${{ steps.app-token.outputs.token }}
+          branch: auto/generate-kong-conf-json-${{ github.run_number }}
+          base: ${{ inputs.dev_site_base_branch }}
+          add-paths: |
+            app/**
+
+      - name: No changes detected
+        if: steps.changes.outputs.changed == 'false'
+        run: |
+          echo "No changes detected in the kong-conf JSON files. No pull request will be created."

.github/workflows/sync-deck.yml

@@ -28,7 +28,7 @@ jobs:
           node extract-help.js
           node fetch-versions.js
       - name: Create pull request
-        uses: peter-evans/create-pull-request@84ae59a2cdc2258d6fa0732dd66352dddae2a412 # v7
+        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
         with:
           title: Sync Deck Releases
           commit-message: Sync Deck Releases

.github/workflows/sync-konnect-oas-data.yml

@@ -21,7 +21,7 @@ jobs:
           npm ci
           node run.js --url ${{ vars.VITE_PORTAL_API_URL }}
       - name: Create pull request
-        uses: peter-evans/create-pull-request@84ae59a2cdc2258d6fa0732dd66352dddae2a412 # v7
+        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
         with:
           title: Sync Konnect OAS Data
           commit-message: Sync Konnect OAS Data

.github/workflows/sync-kuma-submodule.yml

@@ -70,7 +70,7 @@ jobs:
           echo "EOF" >> $GITHUB_ENV
       - name: 'Create pull request'
         # https://github.com/peter-evans/create-pull-request
-        uses: peter-evans/create-pull-request@84ae59a2cdc2258d6fa0732dd66352dddae2a412 # v7
+        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676 # v7
         id: newPR
         with:
           base: main