fix: aws example was incorrect

.github/workflows/deploy.yaml

@@ -15,9 +15,8 @@ jobs:
       uses: actions/checkout@v3
     - name: Build latest dist/ folder
       run: |
-        npm install -g pnpm
-        pnpm install --frozen-lockfile
-        pnpm run build
+        npm ci
+        npm run build
     - name: Upload dist/ folder
       run: |
         git config --global user.email "<41898282+github-actions[bot]@users.noreply.github.com>"
@@ -26,4 +25,5 @@ jobs:
         git add -f dist README.md LICENSE action.yaml
         git commit -m "chore: create ci release ($GITHUB_SHA)"
         git tag --force v1
+        git tag --force $GITHUB_REF_NAME
         git push -f --tags origin deploy

.github/workflows/test.yaml

@@ -13,9 +13,8 @@ jobs:
       uses: actions/checkout@v3
     - name: Build latest dist/ folder
       run: |
-        npm install -g pnpm
-        pnpm install --frozen-lockfile
-        pnpm run build
+        npm ci
+        npm run build
     - name: Upload dist/ folder
       run: |
         git config --global user.email "<41898282+github-actions[bot]@users.noreply.github.com>"

README.md

@@ -12,7 +12,7 @@ To use this action, add the following step to your GitHub Action workflow:
     base64-kube-config: ${{ secrets.KUBE_CONFIG }}
 ```
 
-Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret.
+Keep in mind that the action expects a base64 encoded string of your Kubernetes configuration. The simplest way to do that is to run `cat $HOME/.kube/config | base64` and save that output as an action secret. It's additionally possible to generate a config file using the `aws` CLI for EKS or any other tools with other cloud providers.
 
 It's also possible to specify the version of the [kubectl](https://kubernetes.io/docs/reference/kubectl/) CLI to use. The current default release used by this action is the latest version.
 
@@ -40,3 +40,33 @@ jobs:
         base64-kube-config: ${{ secrets.KUBE_CONFIG }}
     - run: kubectl get pods
 ```
+
+Here's an example using AWS EKS:
+
+```yaml
+name: Kubectl Action
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Configure AWS Credentials
+      uses: aws-actions/configure-aws-credentials@v4
+      with:
+        role-to-assume: arn:aws:iam::123456789100:role/my-github-actions-role
+        aws-region: us-east-2
+    - name: Generate kubeconfig
+      run: |
+        {
+            echo 'EKS_CREDS<<EOF'
+            aws eks update-kubeconfig --region us-east-2 --name my-cluster --dry-run | base64
+            echo EOF
+        } >> $GITHUB_ENV
+    - uses: tale/kubectl-action@v1
+      with:
+        base64-kube-config: ${{ env.EKS_CREDS }}
+    - run: kubectl get pods
+```

action.yaml

@@ -13,6 +13,6 @@ inputs:
     description: A base64 encoded reference to your authorization file (~/.kube/config)
     required: true
 runs:
-  using: node16
+  using: node20
   main: dist/index.js
   post: dist/index.js

package.json

@@ -1,22 +1,21 @@
 {
 	"name": "kubectl-action",
-	"version": "1.1.3",
+	"version": "1.4.0",
 	"scripts": {
 		"dev": "ncc -smw --license licenses.txt build src/main.ts",
 		"build": "ncc -sm --license licenses.txt build src/main.ts",
 		"push": "np --no-cleanup --no-publish --no-tests --message 'chore: v%s'"
 	},
 	"dependencies": {
-		"@actions/core": "^1.10.0",
-		"@actions/tool-cache": "^2.0.1",
-		"undici": "^5.16.0"
+		"@actions/core": "^1.10.1",
+		"@actions/tool-cache": "^2.0.1"
 	},
 	"devDependencies": {
-		"@types/node": "^18.11.18",
-		"@vercel/ncc": "^0.36.0",
-		"eslint": "^8.32.0",
-		"eslint-config-tale": "^1.0.15",
-		"np": "^7.6.3",
-		"typescript": "^4.9.4"
+		"@types/node": "^20.11.30",
+		"@vercel/ncc": "^0.38.1",
+		"eslint": "^8.57.0",
+		"eslint-config-tale": "^1.0.16",
+		"np": "^9.2.0",
+		"typescript": "^5.4.2"
 	}
 }

src/main.ts

@@ -1,12 +1,13 @@
-import { platform } from 'node:process'
+import { env, exit, platform } from 'node:process'
 
 import { debug, getState, setFailed } from '@actions/core'
 import { setupKubeconfig } from 'login'
 import { installKubectl } from 'setup'
 import { teardown } from 'teardown'
 
-if (platform === 'win32') {
+if (env.RUNNER_OS === 'Windows' || platform === 'win32') {
 	setFailed('kubectl-action does not support Windows')
+	exit(1)
 }
 
 if (getState('kubectl-path')) {
@@ -14,7 +15,7 @@ if (getState('kubectl-path')) {
 	teardown()
 		// eslint-disable-next-line unicorn/prefer-top-level-await
 		.catch(error => {
-			setFailed('Failed to install kubectl (this is a bug in kubectl-action): ')
+			setFailed('Failed to teardown kubectl (this is a bug in kubectl-action): ')
 			debug(JSON.stringify(error))
 		})
 } else {

src/setup.ts

@@ -4,7 +4,6 @@ import { env } from 'node:process'
 
 import { addPath, debug, getInput, setFailed } from '@actions/core'
 import { cacheFile, downloadTool, find } from '@actions/tool-cache'
-import { fetch } from 'undici'
 
 export async function installKubectl() {
 	debug('Running kubectl-action installKubectl()')
@@ -36,7 +35,7 @@ export async function installKubectl() {
 		debug(`kubectl ${version} installed and cached at ${path}`)
 	} catch {
 		debug('Failed to download kubectl from dl.k8s.io')
-		setFailed('Failed to download kubectl from dl.k8s.io')
+		setFailed('Failed to download kubectl from dl.k8s.io\nPlease check the version you specified is valid')
 	}
 }
 
@@ -63,11 +62,24 @@ async function fetchKubectl(version: string) {
 		return join(cachedPath, 'kubectl')
 	}
 
-	// TODO: Support other platforms
-	const url = `https://dl.k8s.io/release/${version}/bin/linux/amd64/kubectl`
+	const url = `https://dl.k8s.io/release/${version}/bin/${retrieveRunnerMetadata()}/kubectl`
 
 	console.log(`Downloading kubectl (${url})`)
 	const downloadPath = await downloadTool(url)
 	const toolPath = await cacheFile(downloadPath, 'kubectl', 'kubectl', version)
 	return join(toolPath, 'kubectl')
 }
+
+// Gets the proper architecture and OS for the current platform
+// This doesn't use node functions, but instead CI variables provided by GitHub
+function retrieveRunnerMetadata() {
+	// Currently we don't support win32 platforms anyways
+	const runnerSystem = env.RUNNER_OS === 'Linux' ? 'linux' : 'darwin'
+	const runnerArch = env.RUNNER_ARCH?.toLowerCase()
+
+	if (runnerArch?.includes('arm')) {
+		return `${runnerSystem}/arm64`
+	}
+
+	return `${runnerSystem}/amd64`
+}