Enum ReleaseAction 

pub enum ReleaseAction {
    Status {
        target: Utf8PathBuf,
        wait: Option<String>,
        timeout: u64,
        json: bool,
    },
    Merge {
        target: Utf8PathBuf,
        apply: bool,
        timeout: u64,
        json: bool,
    },
    Request {
        target: Utf8PathBuf,
        json: bool,
    },
    Build {
        target: Utf8PathBuf,
        list: bool,
        json: bool,
    },
    Eligible {
        target: Utf8PathBuf,
        json: bool,
    },
    Publish {
        target: Utf8PathBuf,
        json: bool,
    },
}

The release verbs.

Variants

Status

Report the release style, the release request, the last release, each release line, and every symptom a stuck release shows. The record fields read offline; a forge field reads unknown where this runtime cannot read the forge.

Fields

target: Utf8PathBuf

The repository to report on.

wait: Option<String>

Wait until the publish run and the artifact run on this commit conclude, selected by the commit and never by recency, then report the release they made.

timeout: u64

How long --wait waits before it gives up, in seconds.

json: bool

Emit one JSON object on stdout instead of the human report.

Merge

Merge the trunk’s release request on the operator’s order. Without --apply, read the one open release request against the trunk, the trunk tip, its head, and the required check for that head, and write nothing. With --apply, dispatch the landed merge job with exactly those values, which runs as the release bot, proves each one again, and merges with the head pinned, then wait for that one run. A release line keeps the merge by a person.

Fields

target: Utf8PathBuf

The landed target whose trunk release request merges.

apply: bool

Dispatch the merge job and wait for it; without it, preview.

timeout: u64

How long --apply waits for the merge run, in seconds.

json: bool

Emit one JSON object on stdout instead of the human report.

Request

Keep the one release request of the pushed base on rk-release/<base>: propose the next version, write it and the changelog, force-push as the bot, and open or edit the request, which it never arms: a release waits for the operator’s order. Runs in CI on a push to the trunk or a release line; every fact comes from the record.

Fields

target: Utf8PathBuf

The checkout the release job runs in.

json: bool

Emit one JSON object on stdout instead of the human report.

Build

Decide whether this push releases, and build it: report release, resume, or skip, and write the artifacts’ checksums, the notes, and the report into .rk-release/. A skip exits 0.

Fields

target: Utf8PathBuf

The checkout the release job runs in.

list: bool

Print the files the package holds at HEAD, one path per line, as cargo package --list does, and write nothing: no build output, no report, and no forge read.

json: bool

Emit one JSON object on stdout instead of the human report.

Eligible

Answer whether the change since the last release is worth a release: a file the package ships changed, and a commit that touched the packed files is a feat, fix, or perf commit or marks a breaking change. Writes nothing and reads no forge; the last release is the release tag git holds. A rust target’s request job runs it before release-plz.

Fields

target: Utf8PathBuf

The checkout to judge.

json: bool

Emit one JSON object on stdout instead of the human report.

Publish

Publish what rk release build reported, after the provenance: upload every asset, then create the forge release, which creates the tag last. A rerun keeps what already exists and adds what is missing.

Fields

target: Utf8PathBuf

The checkout the release job runs in.

json: bool

Emit one JSON object on stdout instead of the human report.

Trait Implementations

impl Debug for ReleaseAction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for ReleaseAction

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for ReleaseAction

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand