[pull] master from kubernetes-client:master

.github/dependabot.yml

@@ -5,6 +5,12 @@ updates:
     schedule:
       interval: "daily"
       time: "02:00"
+  - package-ecosystem: "npm"
+    directory: "/"
+    target-branch: "release-1.x"
+    schedule:
+      interval: "daily"
+      time: "01:00"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

.github/workflows/codeql-analysis.yml

@@ -21,6 +21,11 @@ on:
   schedule:
     - cron: '35 14 * * 3'
 
+permissions:
+  actions: read
+  contents: read
+  security-events: write
+
 jobs:
   analyze:
     name: Analyze
@@ -36,11 +41,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -51,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -65,4 +70,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/deploy-docs.yml

@@ -3,16 +3,18 @@ on:
   push:
     branches:
       - master
+permissions:
+  contents: write
 jobs:
   build-and-deploy-docs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '14.x'
+          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
@@ -23,7 +25,7 @@ jobs:
         run: npm run docs
 
       - name: Deploy docs
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.7.2
         with:
           branch: gh-pages # The branch the action should deploy to.
           folder: docs # The folder the action should deploy.

.github/workflows/generate-javascript.yml

@@ -10,7 +10,7 @@ on:
       genCommit:
         type: string
         required: true
-        default: '82c3ff5'
+        default: 'f0bb447'
         description: 'The commit to use for the kubernetes-client/gen repo'
 
 
@@ -19,19 +19,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Javascript
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '20'
       - name: Checkout Gen
         run: |
           git clone https://github.com/kubernetes-client/gen
           pushd gen
           git checkout "${{ github.event.inputs.genCommit }}"
           # apply https://github.com/kubernetes-client/gen/pull/224
           git config --global user.name "Github Actions"
-          git cherry-pick --strategy=recursive -X theirs c557f7f
+          git config --global user.email "<>"
+          git cherry-pick --strategy=recursive -X theirs c557f7f b32dcd6 0ef2cec 9701a7c a608a9d
+          rm -rf gen/.git
+      # apply https://github.com/kubernetes-client/gen/pull/237
+      - name: Patch Dockerfile
+        run: echo "RUN git config --system --add safe.directory /source/openapi-generator" >> gen/openapi/openapi-generator/Dockerfile
       - name: Generate Branch Name
         run: |
           SUFFIX=$(openssl rand -hex 4)

.github/workflows/release.yml

@@ -1,25 +1,64 @@
 name: Release
 
+permissions:
+  contents: write
+
 on:
   workflow_dispatch:
+    inputs:
+      releaseVersion:
+        type: string
+        required: true
+        description: The version of this release. Must be a semantic version of the form X.Y.Z.
+      dry_run:
+        type: boolean
+        required: true
+        default: false
+        description: Dry run, will not push branches or upload the artifacts.
+      pre_release:
+        type: boolean
+        required: true
+        default: false
+        description: If true, push pre-release tag.
+      skip_tag:
+        type: boolean
+        required: true
+        default: false
+        description: If true, don't tag this release, just push it.
 
 jobs:
   release:
     runs-on: ubuntu-latest
     environment: production
     steps:
       - name: Checkout Javascript
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
       - name: Install dependencies
         run: npm install
       - name: Package
         run: ./build-package.sh
       - name: Upload
+        if: ${{ github.event.inputs.dry_run != 'true' && github.event.inputs.pre_release != 'true' }}
         run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+      - name: Upload pre-release
+        if: ${{ github.event.inputs.dry_run != 'true' && github.event.inputs.pre_release == 'true' }}
+        run: npm publish --tag next
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+      - name: Tag release
+        if: ${{ github.event.inputs.skip_tag != 'true' }}
+        run: |
+          git config --global user.name 'Github Bot'
+          git config --global user.email '<>'
+          git tag ${{ github.events.inputs.releaseVersion }}
+      - name: Push tag
+        if: ${{ github.event.inputs.dry_run != 'true' }}
+        run: |
+          git push ${{ github.events.inputs.releaseVersion }}

.github/workflows/test.yml

@@ -11,11 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '18', '16', '14' ]
+        # Remove specific version from 20 when https://github.com/tschaub/mock-fs/issues/380 is fixed
+        node: [ '22', '20.7.0', '18' ]
     name: Node ${{ matrix.node }} validation
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
       # Pre-check to validate that versions match between package.json

.husky/pre-commit

@@ -0,0 +1 @@
+pretty-quick

.husky/pre-push

@@ -0,0 +1 @@
+npm test && npm run lint

.mocharc.json

@@ -1,6 +1,5 @@
 {
-  // Specify "require" for CommonJS
-  "require": "ts-node/register",
+  "require": "tsx",
   "extensions": ["ts"],
   "spec": [
     "src/**/*_test.ts"

FETCH_MIGRATION.md

@@ -2,9 +2,9 @@
 
 Request is fully deprecated requiring us to switch libraries (see [#414](https://github.com/kubernetes-client/javascript/issues/414) for more information). There were a few [different options](https://github.com/kubernetes-client/javascript/issues/414#issuecomment-978031677) for how this swap should be implemented but moving to a new open-api generator option was chosen since this project will acquire the advantages of an up-to-date open-api generator version.
 
-Fetch was selected as the new HTTP request library for this project due to its widespread adoption across the JavaScript ecosystem. Additonally, potential future updates to this project could allow this client to be available with browser JavaScript since fetch is native to the browser ([#165](https://github.com/kubernetes-client/javascript/issues/165)).
+Fetch was selected as the new HTTP request library for this project due to its widespread adoption across the JavaScript ecosystem. Additionally, potential future updates to this project could allow this client to be available with browser JavaScript since fetch is native to the browser ([#165](https://github.com/kubernetes-client/javascript/issues/165)).
 
-[Node-fetch](https://www.npmjs.com/package/node-fetch) is our specific fetch package since it is the largest Node.js compatable implementation. Fetch is not implemented by default in Node.
+[Node-fetch](https://www.npmjs.com/package/node-fetch) is our specific fetch package since it is the largest Node.js compatible implementation. Fetch is not implemented by default in Node.
 
 For more details see the initial discussion ([#754](https://github.com/kubernetes-client/javascript/issues/754)).
 

OWNERS

@@ -1,10 +1,15 @@
 # See the OWNERS docs at https://go.k8s.io/owners
 approvers:
 - brendandburns
-- drubin
+- mstruebing
+- davidgamero
+- cjihrig
 reviewers:
 - brendandburns
-- drubin
-- itowlson 
+- mstruebing
+- davidgamero
+- cjihrig
 emeritus_approvers:
 - mbohlool # 10/22/2020
+- drubin # 11/23/2023
+- itowlson # 11/23/2023

README.md

@@ -29,9 +29,17 @@ kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
-k8sApi.listNamespacedPod('default').then((res) => {
-    console.log(res.body);
-});
+const main = async () => {
+    try {
+        const podsRes = await k8sApi.listNamespacedPod('default');
+        console.log(podsRes.body);
+    } catch (err) {
+        console.error(err);
+    }
+};
+
+main();
+
 ```
 
 ## Create a new namespace
@@ -44,25 +52,27 @@ kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
-var namespace = {
+const namespace = {
     metadata: {
         name: 'test',
     },
 };
 
-k8sApi.createNamespace(namespace).then(
-    (response) => {
-        console.log('Created namespace');
-        console.log(response);
-        k8sApi.readNamespace(namespace.metadata.name).then((response) => {
-            console.log(response);
-            k8sApi.deleteNamespace(namespace.metadata.name, {} /* delete options */);
-        });
-    },
-    (err) => {
-        console.log('Error!: ' + err);
-    },
-);
+const main = async () => {
+    try {
+        const createNamespaceRes = await k8sApi.createNamespace(namespace);
+        console.log('New namespace created: ', createNamespaceRes.body);
+
+        const readNamespaceRes = await k8sApi.readNamespace(namespace.metadata.name);
+        console.log('Namespace: ', readNamespaceRes.body);
+
+        await k8sApi.deleteNamespace(namespace.metadata.name, {});
+    } catch (err) {
+        console.error(err);
+    }
+};
+
+main();
 ```
 
 ## Create a cluster configuration programatically
@@ -113,17 +123,17 @@ release, we will increment the minor version whenever we update the minor Kubern
 
 Generally speaking newer clients will work with older Kubernetes, but compatability isn't 100% guaranteed.
 
-| client version | older versions | 1.19 | 1.20 | 1.21 | 1.22 | 1.23 | 1.24 | 1.25 |
-|----------------|----------------|------|------|------|------|-------|------|-----|
-|  0.13.x        |       -        |  ✓   |  x   |  x   |  x   |  x   |  x   |  x  |
-|  0.14.x        |       -        |  +   |  ✓   |  x   |  x   |  x   |  x   |  x  |
-|  0.15.x        |       -        |  +   |  +   |  ✓   |  x   |  x   |  x   |  x  |
-|  0.16.x        |       -        |  +   |  +   |  +   |  ✓   |  x   |  x   |  x  |
-|  0.17.x        |       -        |  -   |  -   |  +   |  +   |  +   |  ✓   |  x  |
-|  0.18.x        |       -        |  -   |  -   |  -   |  +   |  +   |  +   |  ✓  |
+| client version | older versions | 1.22 | 1.23 | 1.24 | 1.25 | 1.26 | 1.27 | 1.28 | 1.29 | 1.30 |
+|----------------|----------------|------|------|------|-------|------|-----|------|------|-----|
+|  0.16.x        |       -        |  ✓   |  x   |  x   |  x  |  x  |  x  |  x  |  x  |  x  |
+|  0.17.x        |       -        |  +   |  +   |  ✓   |  x  |  x  |  x  |  x  |  x  |  x  |
+|  0.18.x        |       -        |  +   |  +   |  +   |  ✓  |  x  |  x  |  x  |  x  |  x  |
+|  0.19.x        |       -        |  -   |  -   |  -   |  +  |  +  |  ✓  |  x  |  x  |  x  |
+|  0.20.x        |       -        |  -   |  -   |  -   |  -  |  +  |  +  |  ✓  |  x  |  x  |
+|  0.21.x        |       -        |  -   |  -   |  -   |  -  |  -  |  +  |  +  |  ✓  |  x  |
+|  0.22.x        |       -        |  -   |  -   |  -   |  -  |  -  |  -  |  +  |  +  |  ✓  |
 
 Key:
-
 * `✓` Exactly the same features / API objects in both javascript-client and the Kubernetes
   version.
 * `+` javascript-client has features or api objects that may not be present in the

examples/cache-example.js

@@ -8,20 +8,20 @@ const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 const path = '/api/v1/pods';
 const watch = new k8s.Watch(kc);
 
-const listFn = () => k8sApi.listPodForAllNamespaces()
+const listFn = () => k8sApi.listPodForAllNamespaces();
 
 const cache = new k8s.ListWatch(path, watch, listFn);
 
 const looper = () => {
     const list = cache.list('default');
     if (list) {
-        let names = [];
+        const names = [];
         for (let i = 0; i < list.length; i++) {
             names.push(list[i].metadata.name);
         }
         console.log(names.join(','));
     }
     setTimeout(looper, 2000);
-}
+};
 
 looper();

examples/example.js

@@ -1,12 +1,16 @@
 const k8s = require('@kubernetes/client-node');
 
+const namespace = 'default';
+
 const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
 const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
 
-k8sApi.listNamespacedPod('default')
-    .then((res) => {
-	console.log(res.body);
-    });
+const main = async () => {
+    const res = await k8sApi.listNamespacedPod({namespace});
+
+    console.log(`${namespace} namespace pods: `, res.items);
+};
 
+main();