Struct ProfileFlags 

pub struct ProfileFlags {
    pub technology: Vec<String>,
    pub forge: Option<String>,
    pub repo: Option<String>,
    pub release_mode: Option<String>,
    pub release_driver: Option<String>,
    pub release_style: Option<String>,
    pub trunk: Option<String>,
    pub checkout_mode: Option<String>,
    pub integration: Option<String>,
    pub merge_form: Option<String>,
    pub required_check: Option<String>,
    pub build_packages: Option<String>,
}

The profile and Git workflow answers an invocation states.

Fields

technology: Vec<String>

A technology present in the project; repeat it for several. A supplied list replaces the configured one whole. Defaults to detection from the version files.

forge: Option<String>

The forge hosting the project: github or gitlab. Defaults to detection from the target’s git remote; a project with no forge resolves to none.

repo: Option<String>

The project path on the forge, substituted into the rendered files and recorded as the landing parameter. Defaults to detection from the target’s git remote.

release_mode: Option<String>

The release intent: automatic, where release-kit drives the release; external, where the project releases through a process release-kit does not drive; or none. Defaults to the observation’s proposal: automatic with the one release-bearing technology, none where there is none.

release_driver: Option<String>

The technology that states the version and takes the bot, for an automatic release. Required where more than one release-bearing technology is present.

release_style: Option<String>

The release style of an automatic release: trunk (the trunk’s request merges on the operator’s order) or lines (the project keeps release lines, and every request waits for a human’s merge).

trunk: Option<String>

The one permanent branch. Defaults to the configuration, the record, and then master.

checkout_mode: Option<String>

Where a topic branch opens: linked-worktree (every code-changing branch in its own linked worktree, the main checkout commits nothing) or main-worktree (the original working tree switches to it). Recorded as a Git workflow parameter and rendered into the landed blocks.

integration: Option<String>

Which authority moves an implementation onto the trunk: local (the checkout squashes and records it, through rk integrate) or forge (a pull request or merge request does, behind its required check). Recorded as a Git workflow parameter and rendered into the landed blocks. Defaults to local.

merge_form: Option<String>

How the commits of a branch reach the trunk: squash (the branch arrives as one commit) or rebase (the branch is rebased on the trunk tip and the trunk fast-forwards to it, every commit keeping its own message). Recorded as a Git workflow parameter. Defaults to squash.

required_check: Option<String>

The check the trunk ruleset requires before a release request merges. GitHub only.

build_packages: Option<String>

The packages the release job of an automatic bash release installs before it runs the verify command, separated by spaces. Recorded as a release parameter. Defaults to make.

Implementations

impl ProfileFlags

pub const fn is_empty(&self) -> bool

Whether no flag answered anything.

pub fn inputs(&self) -> Result<Inputs<'_>, RkError>

The parsed answers, as the resolution takes them.

Errors

Returns crate::error::RkError::Usage for a value outside its vocabulary.

Trait Implementations

impl Args for ProfileFlags

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl Clone for ProfileFlags

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProfileFlags

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

Formats the value using the given formatter.

impl Default for ProfileFlags

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for ProfileFlags

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.