From ca5347f4b417008c31cf793a436c229971d4a132 Mon Sep 17 00:00:00 2001 From: Matheus Pimenta Date: Mon, 29 Jun 2026 11:14:14 +0100 Subject: [PATCH] Improve docs for plugins action installation Signed-off-by: Matheus Pimenta --- action/README.md | 9 +++++---- action/action.yml | 4 +++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/action/README.md b/action/README.md index 5921acfe..0a09132f 100644 --- a/action/README.md +++ b/action/README.md @@ -26,10 +26,11 @@ steps: ``` Installing plugins requires a Flux version with plugin support (v2.9.0 or later). -The `plugins` input accepts one plugin per line in `@` -format. The `plugin-dir` input is only used when `plugins` is set; when -plugins are installed, the action exports `FLUXCD_PLUGINS` for subsequent -steps. +The `plugins` input accepts one plugin per line in ``, +`@`, or `@` format. Entries without a version or +digest install the latest version from the catalog. The `plugin-dir` input is +only used when `plugins` is set; when plugins are installed, the action exports +`FLUXCD_PLUGINS` for subsequent steps. The Flux GitHub Action can be used to automate various tasks in CI, such as: diff --git a/action/action.yml b/action/action.yml index c81cfddb..330166f7 100644 --- a/action/action.yml +++ b/action/action.yml @@ -14,7 +14,9 @@ inputs: deprecationMessage: "No longer required, action will now detect runner arch." plugins: description: > - Plugins to install alongside Flux. One per line: `@`. Example: `mirror@0.0.1` + Plugins to install alongside Flux. One per line: ``, `@` or + `@`. Entries without a version or digest install the latest + version from the catalog. Example: `mirror@0.0.1` required: false plugin-dir: description: >