Merge branch 'main' into release-1.1.patch-dherbolt

Author: Daniel Herbolt

.github/dependabot.yml

@@ -6,12 +6,6 @@ updates:
           interval: 'daily'
           time: '02:00'
       target-branch: 'main'
-    - package-ecosystem: 'npm'
-      directory: '/'
-      target-branch: 'master'
-      schedule:
-          interval: 'daily'
-          time: '01:00'
     - package-ecosystem: 'github-actions'
       directory: '/'
       schedule:

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v4.2.2
+              uses: actions/checkout@v5.0.0
 
             # Initializes the CodeQL tools for scanning.
             - name: Initialize CodeQL

.github/workflows/deploy-docs.yml

@@ -1,29 +1,29 @@
 name: Build and Deploy Docs
 on:
-  push:
-    branches:
-      - master
+    push:
+        branches:
+            - main
 jobs:
-  build-and-deploy-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4.2.2
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      # Pre-check to validate that versions match between package.json
-      # and package-lock.json. Needs to run before npm install
-      - name: Validate package.json and package-lock.json versions
-        run: node version-check.js
-      - name: Install dependencies
-        run: npm ci
-      - name: Build docs
-        run: npm run docs
+    build-and-deploy-docs:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v5.0.0
+            - name: Setup Node.js
+              uses: actions/setup-node@v5
+              with:
+                  node-version: '20'
+            # Pre-check to validate that versions match between package.json
+            # and package-lock.json. Needs to run before npm install
+            - name: Validate package.json and package-lock.json versions
+              run: node version-check.js
+            - name: Install dependencies
+              run: npm ci
+            - name: Build docs
+              run: npm run docs
 
-      - name: Deploy docs
-        uses: JamesIves/github-pages-deploy-action@v4.7.3
-        with:
-          branch: gh-pages # The branch the action should deploy to.
-          folder: docs # The folder the action should deploy.
+            - name: Deploy docs
+              uses: JamesIves/github-pages-deploy-action@v4.7.3
+              with:
+                  branch: gh-pages # The branch the action should deploy to.
+                  folder: docs # The folder the action should deploy.

.github/workflows/generate-javascript.yml

@@ -1,53 +1,52 @@
 name: Generate
 
 on:
-  workflow_dispatch:
-    inputs:
-      kubernetesBranch:
-        type: string
-        required: true
-        description: 'The remote kubernetes release branch to fetch openapi spec. .e.g. "release-1.23"'
-      genCommit:
-        type: string
-        required: true
-        default: 'b461333bb57fa2dc2152f939ed70bac3cef2c1f6'
-        description: 'The commit to use for the kubernetes-client/gen repo'
-
+    workflow_dispatch:
+        inputs:
+            kubernetesBranch:
+                type: string
+                required: true
+                description: 'The remote kubernetes release branch to fetch openapi spec. .e.g. "release-1.23"'
+            genCommit:
+                type: string
+                required: true
+                default: 'b461333bb57fa2dc2152f939ed70bac3cef2c1f6'
+                description: 'The commit to use for the kubernetes-client/gen repo'
 
 jobs:
-  generate:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Javascript
-        uses: actions/checkout@v4.2.2
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - name: Generate Openapi
-        run: |
-          echo "export KUBERNETES_BRANCH=${{ github.event.inputs.kubernetesBranch }} >> ./settings"
-          echo "export GEN_COMMIT="${{ github.event.inputs.genCommit }}" >> ./settings"
-          ./generate-client.sh
-      - name: Generate Branch Name
-        run: |
-          SUFFIX=$(openssl rand -hex 4)
-          echo "BRANCH=automated-generate-$SUFFIX" >> $GITHUB_ENV
-      - name: Commit and push
-        run: |
-          # Commit and push
-          git config user.email "k8s.ci.robot@gmail.com"
-          git config user.name "Kubernetes Prow Robot"
-          git checkout -b "$BRANCH"
-          git add .
-          # we modify the settings file in "Generate Openapi" but do not want to commit this
-          git reset settings
-          git commit -s -m 'Automated openapi generation from ${{ github.event.inputs.kubernetesBranch }}'
-          git push origin "$BRANCH"
-      - name: Pull Request
-        uses: repo-sync/pull-request@v2
-        with:
-          source_branch: ${{ env.BRANCH }}
-          destination_branch: ${{ github.ref_name }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          pr_title: "Automated Generate from openapi ${{ github.event.inputs.kubernetesBranch }}"
+    generate:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Javascript
+              uses: actions/checkout@v5.0.0
+            - name: Setup Node
+              uses: actions/setup-node@v5
+              with:
+                  node-version: '20'
+            - name: Generate Openapi
+              run: |
+                  echo "export KUBERNETES_BRANCH=${{ github.event.inputs.kubernetesBranch }} >> ./settings"
+                  echo "export GEN_COMMIT="${{ github.event.inputs.genCommit }}" >> ./settings"
+                  ./generate-client.sh
+            - name: Generate Branch Name
+              run: |
+                  SUFFIX=$(openssl rand -hex 4)
+                  echo "BRANCH=automated-generate-$SUFFIX" >> $GITHUB_ENV
+            - name: Commit and push
+              run: |
+                  # Commit and push
+                  git config user.email "k8s.ci.robot@gmail.com"
+                  git config user.name "Kubernetes Prow Robot"
+                  git checkout -b "$BRANCH"
+                  git add .
+                  # we modify the settings file in "Generate Openapi" but do not want to commit this
+                  git reset settings
+                  git commit -s -m 'Automated openapi generation from ${{ github.event.inputs.kubernetesBranch }}'
+                  git push origin "$BRANCH"
+            - name: Pull Request
+              uses: repo-sync/pull-request@v2
+              with:
+                  source_branch: ${{ env.BRANCH }}
+                  destination_branch: ${{ github.ref_name }}
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  pr_title: 'Automated Generate from openapi ${{ github.event.inputs.kubernetesBranch }}'

.github/workflows/release.yml

@@ -33,9 +33,9 @@ jobs:
         environment: production
         steps:
             - name: Checkout Javascript
-              uses: actions/checkout@v4.2.2
+              uses: actions/checkout@v5.0.0
             - name: Setup Node
-              uses: actions/setup-node@v4
+              uses: actions/setup-node@v5
               with:
                   node-version: '20'
                   registry-url: 'https://registry.npmjs.org'

.github/workflows/test.yml

@@ -11,11 +11,11 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                node: ['23', '22', '20', '18']
+                node: ['24', '23', '22', '20', '18']
         name: Node ${{ matrix.node }} validation
         steps:
-            - uses: actions/checkout@v4.2.2
-            - uses: actions/setup-node@v4
+            - uses: actions/checkout@v5.0.0
+            - uses: actions/setup-node@v5
               with:
                   node-version: ${{ matrix.node }}
             # Pre-check to validate that versions match between package.json

README.md

@@ -63,7 +63,7 @@ k8sApi.createNamespace({ body: namespace }).then(
 );
 ```
 
-## Create a cluster configuration programatically
+## Create a cluster configuration programmatically
 
 ```javascript
 const k8s = require('@kubernetes/client-node');
@@ -112,16 +112,17 @@ release, we will increment the minor version whenever we update the minor Kubern
 
 We switched from `request` to `fetch` as the HTTP(S) backend for the `1.0.0` release.
 
-Generally speaking newer clients will work with older Kubernetes, but compatability isn't 100% guaranteed.
+Generally speaking newer clients will work with older Kubernetes, but compatibility isn't 100% guaranteed.
 
-| client version | older versions | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 |
-| -------------- | -------------- | ---- | ---- | ---- | ---- | ---- |
-| 0.19.x         | -              | ✓    | x    | x    | x    | x    |
-| 0.20.x         | -              | +    | ✓    | x    | x    | x    |
-| 0.21.x         | -              | +    | +    | ✓    | x    | x    |
-| 0.22.x         | -              | +    | +    | +    | ✓    | x    |
-| 1.0.x          | -              | +    | +    | +    | +    | ✓    |
-| 1.1.x          | -              | +    | +    | +    | +    | ✓    |
+| client version | older versions | 1.28 | 1.29 | 1.30 | 1.31 | 1.32 | 1.33 |
+| -------------- | -------------- | ---- | ---- | ---- | ---- | ---- | ---- |
+| 0.19.x         | -              | ✓    | x    | x    | x    | x    | x    |
+| 0.20.x         | -              | +    | ✓    | x    | x    | x    | x    |
+| 0.21.x         | -              | +    | +    | ✓    | x    | x    | x    |
+| 0.22.x         | -              | +    | +    | +    | ✓    | x    | x    |
+| 1.0.x          | -              | +    | +    | +    | +    | ✓    | x    |
+| 1.1.x          | -              | +    | +    | +    | +    | ✓    | x    |
+| 1.2.x          | -              | +    | +    | +    | +    | +    | ✓    |
 
 Key:
 
@@ -142,6 +143,8 @@ Key:
   Credentials are cached based on the kubeconfig username and these can collide across configs.
   Here is the related [issue](https://github.com/kubernetes-client/javascript/issues/592).
 
+- In scenarios where multiple headers with the same key are required in a request, such as `Impersonate-Group`, avoid using `fetch`. Fetch will merge the values into a single header key, with the values as a single string vs a list of strings, `Impersonate-Group: "group1,group2"`. The workaround is to use a low-level library such as `https` to make the request. Refer to issue [#2474](https://github.com/kubernetes-client/javascript/issues/2474) for more details.
+
 # Development
 
 All dependencies of this project are expressed in its

examples/patch-example.js

@@ -20,7 +20,7 @@ try {
 
     await k8sApi.patchNamespacedPod(
         { name: res?.items?.[0]?.metadata?.name ?? '', namespace, body: patch },
-        k8s.setHeaderOptions('Content-Type', k8s.JsonPatch),
+        k8s.setHeaderOptions('Content-Type', k8s.PatchStrategy.JsonPatch),
     );
 
     console.log('Patched.');