Merge pull request #5975 from somaz94/action-version-file

Add version-file input to the Flux CLI action

Author: stefanprodan

.github/workflows/action.yaml

@@ -28,6 +28,33 @@ jobs:
       - name: Setup flux
         uses: ./action
 
+  version-file:
+    runs-on: ubuntu-latest
+    name: action version-file on ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - name: Setup flux from a plain version file
+        uses: ./action
+        with:
+          version-file: action/testdata/.flux-version
+      - name: Assert plain version file
+        shell: bash
+        run: |
+          set -euo pipefail
+          flux -v
+          flux -v | grep -q '2.8.8'
+      - name: Setup flux from a .tool-versions file
+        uses: ./action
+        with:
+          version-file: action/testdata/.tool-versions
+      - name: Assert .tool-versions file
+        shell: bash
+        run: |
+          set -euo pipefail
+          flux -v
+          flux -v | grep -q '2.9.2'
+
   plugins:
     runs-on: ubuntu-latest
     name: action plugins on ubuntu-latest

action/README.md

@@ -12,6 +12,22 @@ steps:
     run: flux version --client
 ```
 
+To pin the Flux version from a file instead of hardcoding it in the workflow:
+
+```yaml
+steps:
+  - name: Setup Flux CLI
+    uses: fluxcd/flux2/action@main
+    with:
+      version-file: .flux-version
+  - name: Run Flux CLI
+    run: flux version --client
+```
+
+The `version-file` input accepts a `.tool-versions` file (asdf format, reads the
+`flux` entry) or a plain text file containing a single version such as `2.0.0`.
+It is ignored when `version` is set.
+
 To install Flux plugins alongside the CLI:
 
 ```yaml

action/action.yml

@@ -8,6 +8,13 @@ inputs:
   version:
     description: "Flux version e.g. 2.0.0 (defaults to latest stable release)"
     required: false
+  version-file:
+    description: >
+      Path to a file specifying the Flux version to install. Accepts a
+      `.tool-versions` file (asdf format, reads the `flux` entry) or a plain
+      text file containing a single version such as `2.0.0`. Ignored when
+      `version` is set.
+    required: false
   arch:
     description: "arch can be amd64, arm64 or arm"
     required: false
@@ -44,9 +51,26 @@ runs:
       id: setup-flux-bin
       env:
         VERSION: "${{ inputs.version }}"
+        VERSION_FILE: "${{ inputs.version-file }}"
         FLUX_TOOL_DIR: "${{ inputs.bindir }}"
         TOKEN: "${{ inputs.token }}"
       run: |
+        if [[ -z "$VERSION" ]] && [[ -n "$VERSION_FILE" ]]; then
+          if [[ ! -f "$VERSION_FILE" ]]; then
+            echo "version-file '$VERSION_FILE' not found"
+            exit 1
+          fi
+          if [[ "$(basename "$VERSION_FILE")" == ".tool-versions" ]]; then
+            VERSION=$(grep -E '^[[:space:]]*flux2?[[:space:]]' "$VERSION_FILE" | head -n1 | awk '{print $2}' | tr -d '[:space:]')
+          else
+            VERSION=$(grep -vE '^[[:space:]]*(#|$)' "$VERSION_FILE" | head -n1 | tr -d '[:space:]')
+          fi
+          if [[ -z "$VERSION" ]]; then
+            echo "Unable to read Flux version from '$VERSION_FILE'"
+            exit 1
+          fi
+        fi
+
         if [[ -z "$VERSION" ]] || [[ "$VERSION" = "latest" ]]; then
           if [[ "${TOKEN}" != '' ]]; then
             VERSION=$(curl -fsSL -H "Authorization: token ${TOKEN}" https://api.github.com/repos/fluxcd/flux2/releases/latest | grep tag_name | cut -d '"' -f 4)

action/testdata/.flux-version

@@ -0,0 +1 @@
+2.8.8

action/testdata/.tool-versions

@@ -0,0 +1 @@
+flux 2.9.2