Merge pull request #20 from nolar/skip-cluster-creation

Add an option to skip the cluster creation

Author: nolar

.github/workflows/ci.yaml

@@ -48,6 +48,16 @@ jobs:
           K3S: ${{ steps.install.outputs.k3s-version }}
           K8S: ${{ steps.install.outputs.k8s-version }}
 
+  test-skip-creation:
+    name: Skip creation
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./  # normally: nolar/setup-k3d-k3s@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          skip-creation: true
+
   test-skip-readiness:
     name: Skip readiness
     runs-on: ubuntu-22.04

README.md

@@ -105,6 +105,16 @@ with:
 ```
 
 
+### `skip-creation`
+
+Whether to return from the action as soon as possible
+without the cluster creation (the cluster readiness is also skipped).
+This can be useful to only install the tools for manual cluster creation,
+or to parse the available versions and return them as the action's outputs.
+
+By default (`false`), the cluster is created.
+
+
 ### `skip-readiness`
 
 Whether to return from the action as soon as possible,

action.sh

@@ -77,11 +77,15 @@ echo "k3s-version=${K3S}" >> $GITHUB_OUTPUT
 echo "k8s-version=${K8S}" >> $GITHUB_OUTPUT
 
 # Start a cluster. It takes 20 seconds usually.
-k3d cluster create ${K3D_NAME:-} --wait --image=rancher/k3s:"${K3S//+/-}" ${K3D_ARGS:-}
+if [[ -z "${SKIP_CREATION}" ]]; then
+  k3d cluster create ${K3D_NAME:-} --wait --image=rancher/k3s:"${K3S//+/-}" ${K3D_ARGS:-}
+else
+  echo "Skipping the cluster creation. The cluster can be not fully ready yet."
+fi
 
 # Sometimes, the service account is not created immediately. Nice trick, but no:
 # we need to wait until the cluster is fully ready before starting the tests.
-if [[ -z "${SKIP_READINESS}" ]]; then
+if [[ -z "${SKIP_CREATION}" && -z "${SKIP_READINESS}" ]]; then
   echo "::group::Waiting for cluster readiness"
   while ! kubectl get serviceaccount default >/dev/null; do sleep 1; done
   echo "::endgroup::"

action.yaml

@@ -22,6 +22,9 @@ inputs:
   github-token:
     description: Optional GitHub token to overcome API rate limiting.
     required: false
+  skip-creation:
+    description: Skip creating the cluster and waiting for its readiness?
+    required: false
   skip-readiness:
     description: Skip waiting for full cluster readiness?
     required: false
@@ -47,8 +50,10 @@ runs:
         K3D_NAME: ${{ inputs.k3d-name }}
         K3D_ARGS: ${{ inputs.k3d-args }}
         GITHUB_TOKEN: ${{ inputs.github-token }}
+        SKIP_CREATION: ${{ inputs.skip-creation && 'yes' || '' }}
         SKIP_READINESS: ${{ inputs.skip-readiness && 'yes' || '' }}
 
     # Validate that everything is installed, is on PATH, and generally works.
     - shell: bash
       run: kubectl version
+      if: ${{ !inputs.skip-creation }}