1
0
mirror of synced 2026-06-29 23:00:48 +00:00

Improve docs for plugins action installation

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
This commit is contained in:
Matheus Pimenta
2026-06-29 11:14:14 +01:00
parent 4b7e9eef43
commit ca5347f4b4
2 changed files with 8 additions and 5 deletions
+5 -4
View File
@@ -26,10 +26,11 @@ steps:
``` ```
Installing plugins requires a Flux version with plugin support (v2.9.0 or later). Installing plugins requires a Flux version with plugin support (v2.9.0 or later).
The `plugins` input accepts one plugin per line in `<name>@<version|digest>` The `plugins` input accepts one plugin per line in `<name>`,
format. The `plugin-dir` input is only used when `plugins` is set; when `<name>@<version>`, or `<name>@<digest>` format. Entries without a version or
plugins are installed, the action exports `FLUXCD_PLUGINS` for subsequent digest install the latest version from the catalog. The `plugin-dir` input is
steps. 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: The Flux GitHub Action can be used to automate various tasks in CI, such as:
+3 -1
View File
@@ -14,7 +14,9 @@ inputs:
deprecationMessage: "No longer required, action will now detect runner arch." deprecationMessage: "No longer required, action will now detect runner arch."
plugins: plugins:
description: > description: >
Plugins to install alongside Flux. One per line: `<name>@<version|digest>`. Example: `mirror@0.0.1` Plugins to install alongside Flux. One per line: `<name>`, `<name>@<version>` or
`<name>@<digest>`. Entries without a version or digest install the latest
version from the catalog. Example: `mirror@0.0.1`
required: false required: false
plugin-dir: plugin-dir:
description: > description: >