Skip to main content

PackageConfig

Struct PackageConfig 

Source
pub struct PackageConfig {
    pub path: String,
    pub version_files: Vec<String>,
    pub version_files_strict: bool,
    pub stage_files: Vec<String>,
    pub artifacts: Vec<String>,
    pub changelog: Option<ChangelogConfig>,
    pub publish: Option<PublishConfig>,
}
Expand description

A releasable package — version files, artifacts, build/publish targets.

All packages share one global release tag (git.tag_prefix + semver) and one version line. Each package’s version_files are bumped to that same global version on every release; packages[] controls where to write versions and how to publish, not how to version.

sr does not run user shell commands. Artifact builds happen in CI between sr prepare and sr release; sr uploads whatever paths in artifacts point to at tag time.

Fields§

§path: String

Directory path relative to repo root. Used for organizing changelog sections and as the working directory for typed publishers.

§version_files: Vec<String>

Manifest files to bump with the global release version. Literal paths only — no glob expansion.

§version_files_strict: bool

Fail on unsupported version file formats.

§stage_files: Vec<String>

Additional files to stage in the release commit. Literal paths only.

§artifacts: Vec<String>

Artifact files to upload as release assets. Literal paths only — every entry must exist on disk before the tag is created.

§changelog: Option<ChangelogConfig>

Changelog config override for this package.

§publish: Option<PublishConfig>

Per-package publish target (invoked during sr release).

Trait Implementations§

Source§

impl Clone for PackageConfig

Source§

fn clone(&self) -> PackageConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PackageConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PackageConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for PackageConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PackageConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,