A collection of +180 reusable WebAssembly modules for building composable CI/CD pipelines with FluentCI fluentci.io/modules
modules security plumber COMPONENT.md
4.4 kB · 73 lines
Markdown
at main

plumber component functions #

Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted.

run #

Execute arbitrary literal CLI arguments.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
arguments array yes Literal native CLI argument tokens, passed without shell expansion.

Returns Contract.ExecutionResult.

version #

Print the CLI version.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.

Returns Contract.ExecutionResult.

analyze #

Audit GitHub Actions/GitLab CI with a score gate and failing provider/collection errors.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
provider string no Provider supplied to the plumber analyze operation. Allowed values: github, gitlab.
repository string no Repository supplied to the plumber analyze operation.
config string no Named configuration selected by the native tool.
min-score string no Min Score supplied to the plumber analyze operation. Allowed values: A, B, C, D, E.
min-points integer no Min Points supplied to the plumber analyze operation.
output string no Destination path for generated packages.
sarif string no Sarif supplied to the plumber analyze operation.
glsast string no Glsast supplied to the plumber analyze operation.
pbom string no Pbom supplied to the plumber analyze operation.
branch string no Branch supplied to the plumber analyze operation.
target string no Target selected for this native operation.

Returns Contract.ExecutionResult.

validate-config #

Validate Plumber policy configuration without running a repository audit.

Argument Type Required Description
project string no Working directory containing the source checkout; defaults to the current directory. Default: ".".
run-dir string yes Fresh directory for this invocation’s execution report and task logs; must not already exist.
executable string no Native CLI executable name or absolute path; defaults to this operation’s tool.
timeout-ms integer no Maximum task duration in milliseconds; defaults to 900000. Default: 900000.
artifacts array no Output artifacts to collect as NAME=PATH entries; names must be unique.
config string no Named configuration selected by the native tool.

Returns Contract.ExecutionResult.