Struct ReleaseState 

pub struct ReleaseState {
    pub(crate) cargo: Option<CargoReleaseState>,
    pub(crate) npm: Option<NpmReleaseState>,
    pub(crate) authoritative_branch: BranchName,
    pub(crate) proposal_branch: BranchName,
    pub(crate) commit_subject: CommitSubject,
    pub(crate) commit_format: Option<CommitFormat>,
    pub(crate) units: BTreeMap<String, ReleaseUnitState>,
    pub(crate) artifacts: BTreeMap<String, BTreeMap<String, ReleaseArtifactState>>,
    pub(crate) account: Account<Expr>,
    pub(crate) packages_credential: String,
}

Evaluated release policy. This component can be decoded on its own.

Fields

cargo: Option<CargoReleaseState>

Cargo registry settings, when Cargo units publish.

npm: Option<NpmReleaseState>

npm registry settings, when npm units publish.

authoritative_branch: BranchName

Merged branch from which publication is permitted.

proposal_branch: BranchName

Maintained release proposal branch.

commit_subject: CommitSubject

Subject template of the proposal commits.

commit_format: Option<CommitFormat>

Format of the commit messages that bumps and changelog entries are derived from.

units: BTreeMap<String, ReleaseUnitState>

Release units by ID.

artifacts: BTreeMap<String, BTreeMap<String, ReleaseArtifactState>>

Publication artifacts by unit ID, then artifact name.

account: Account<Expr>

Who commits, tags and logs in to registries.

packages_credential: String

Name of the credential that uploads packages and logs in to OCI registries.

Implementations

impl ReleaseState

pub(crate) fn application_units( &self, units: &[Unit], bump: ApplicationBump, ) -> BTreeSet<String>

Resolved application units configured with the given automatic bump.

impl ReleaseState

pub(crate) fn selected_units<G: GitHistory + GitRefs>( &self, repository: &RepositoryRoot, commit: &str, git: &G, ) -> Result<Vec<Unit>, PublicationError>

Select the configured units this run publishes or resumes.

Errors

Returns an error for invalid release state, git failures, or malformed versions.

pub(crate) fn stage_releases<'a>( &'a self, repository: &RepositoryRoot, commit: &str, units: Vec<Unit>, artifacts: Option<&Stage>, login: Option<&OciLogin>, ) -> Result<Vec<UnitRelease<'a>>, PublicationError>

Stage the forge release of every selected unit, checking every local file before anything is created.

Errors

Returns an error for invalid artifact configuration, a zero revision, a unit with artifacts but no artifacts, or staged files that do not match, or an OCI artifact has no login.

impl ReleaseState

pub const fn commit_subject(&self) -> &CommitSubject

The subject template of the proposal commits.

pub fn cargo_registry(&self) -> Option<&str>

The named Cargo registry to publish to, when one is configured.

pub fn cargo_registry_api_url(&self) -> Option<&str>

The Cargo registry API base URL used to check published versions.

pub fn npm_registry(&self) -> Option<&str>

The npm registry base URL, when one is configured.

pub const fn account(&self) -> &Account<Expr>

The expressions of the account the release acts as.

pub fn packages_credential(&self) -> &str

The name of the credential for package uploads and registry logins.

pub(crate) fn discover_units( &self, root: &RepositoryRoot, ) -> Result<Vec<Unit>, ResolveError>

Resolve configured release targets into graph units.

Errors

Returns an error when a configured unit cannot be resolved.

pub fn plan_local( &self, root: &RepositoryRoot, release_id: &str, target_version: &str, date: &str, ) -> Result<LocalPlan, Error>

Validate one configured unit’s local release plan for Check, Diff, or Apply.

Errors

Returns errors for unknown units, invalid or non-increasing versions, unsafe paths, and invalid target plans.

pub fn branches( &self, requested_proposal: Option<&str>, ) -> Result<(AuthorityBranch, String), Error>

The authoritative branch and the proposal branch, checking an explicit proposal branch against the evaluated release policy.

Errors

Returns an error when the explicit proposal branch conflicts with the configured one.

Trait Implementations

impl Clone for ReleaseState

fn clone(&self) -> ReleaseState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseState

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

Formats the value using the given formatter.

impl Eq for ReleaseState

impl<'ʄ> Facet<'ʄ> for ReleaseState

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for ReleaseState

fn eq(&self, other: &ReleaseState) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReleaseState