Struct Release

pub struct Release {
    pub command: Option<Command>,
    pub registry: Option<String>,
    pub manifest_path: Option<String>,
    pub version: Option<String>,
    pub config: Option<String>,
    pub token: Option<String>,
    pub backend: Option<Backend>,
}

Fields

command: Option<Command>

The release-plz command to run. Accepted values: release-pr, release. (By default it runs both commands).

registry: Option<String>

Registry where the packages are stored. The registry name needs to be present in the Cargo config. If unspecified, the publish field of the package manifest is used. If the publish field is empty, crates.io is used.

manifest_path: Option<String>

Path to the Cargo.toml of the project you want to update. Both Cargo workspaces and single packages are supported. (Defaults to the root directory).

version: Option<String>

Release-plz version to use. E.g. 0.3.70. (Default: latest version).

config: Option<String>

Release-plz config file location. (Defaults to release-plz.toml or .release-plz.toml).

token: Option<String>

Token used to publish to the cargo registry.

backend: Option<Backend>

Forge backend. Valid values: github, gitea. (Defaults to github).

Implementations

impl Release

pub fn command(self, value: impl Into<Command>) -> Self

Sets the command field of this struct.

pub fn registry(self, value: impl Into<String>) -> Self

Sets the registry field of this struct.

pub fn manifest_path(self, value: impl Into<String>) -> Self

Sets the manifest_path field of this struct.

pub fn version(self, value: impl Into<String>) -> Self

Sets the version field of this struct.

pub fn config(self, value: impl Into<String>) -> Self

Sets the config field of this struct.

pub fn token(self, value: impl Into<String>) -> Self

Sets the token field of this struct.

pub fn backend(self, value: impl Into<Backend>) -> Self

Sets the backend field of this struct.

Trait Implementations

impl Clone for Release

fn clone(&self) -> Release

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Release

fn default() -> Release

Returns the “default value” for a type.

impl From<Release> for Step<Use>

fn from(value: Release) -> Self

Converts to this type from the input type.