Skip to main content

NightlyConfig

Struct NightlyConfig 

Source
pub struct NightlyConfig {
    pub version_template: Option<String>,
    pub name_template: Option<String>,
    pub tag_name: Option<String>,
    pub publish_release: Option<bool>,
    pub publish_repo: Option<String>,
    pub keep_single_release: Option<bool>,
    pub retention: Option<RetentionConfig>,
    pub draft: Option<bool>,
    pub prerelease: Option<bool>,
    pub make_latest: Option<MakeLatestConfig>,
}

Fields§

§version_template: Option<String>

Template for the rendered version string the nightly run sets on Version / RawVersion. Default: "{{ incpatch(v=Version) }}-{{ ShortCommit }}-nightly" — produces commit-immutable nightly versions (two same-day commits yield two distinct nightly versions).

The {{ NightlyBuild }} template var (a stateless per-base-version build counter derived from git rev-list --count <last-tag>..HEAD) enables nushell-style schemes such as "{{ Base }}-nightly.{{ NightlyBuild }}+{{ ShortCommit }}".

§name_template: Option<String>

Template for the release name. Default: "{{ ProjectName }}-nightly".

§tag_name: Option<String>

Tag name used for the nightly release. Default: "nightly". Templates allowed.

§publish_release: Option<bool>

Whether to publish a GitHub Release at all. Default: true. Set false for nightly-only docker pushes / blob uploads.

§publish_repo: Option<String>

Publish the nightly release to a DIFFERENT repository than the source repo, in "owner/repo" form (e.g. "nushell/nightly"). Default (None) publishes to the configured release.github repo, unchanged.

When set, the nightly release create, asset upload, AND retention (keep_single_release / retention.keep_last) delete calls all target this repo. The active SCM token is assumed to have write access to publish_repo. GitHub-only (the nushell adoption target).

§keep_single_release: Option<bool>

Delete the prior release that points at the same tag before creating the new one. Default: false. Set true to maintain a single rolling nightly release on GitHub.

Back-compat alias for retention: { keep_last: 1 }. When both keep_single_release and retention are set, retention wins. Destructive: deletes a published release via the GitHub Releases API. GitHub-only.

§retention: Option<RetentionConfig>

Retention policy for nightly releases on GitHub. Generalizes keep_single_release (which is keep_last: 1): keeps the N newest nightly releases matching the nightly tag/name and deletes the rest (releases + the tags anodizer created for them). Operates on publish_repo when set. Default (None): no retention sweep.

§draft: Option<bool>

Override release.draft for nightly runs only. None falls through to release.draft; Some(v) overrides it.

§prerelease: Option<bool>

Mark the nightly release as a prerelease. Default: true.

Unlike Self::draft, None does NOT fall through to release.prerelease — that field resolves to false for a nightly (an unset config is false, and prerelease: auto cannot help because the default nightly tag is not a parseable semver tag), so falling through would publish every nightly as a stable release. Set false to opt out.

§make_latest: Option<MakeLatestConfig>

Override release.make_latest for nightly runs only. Default: false — a rolling nightly must not displace the newest stable release in the GitHub UI, in releases/latest, or for the install scripts and gh release download invocations that resolve it.

None does not fall through to release.make_latest for the same reason as Self::prerelease: unset there means GitHub’s own default, which IS latest.

Implementations§

Source§

impl NightlyConfig

Source

pub fn resolved_keep_last(&self) -> Option<usize>

Resolve the effective keep_last retention count, or None when no retention is requested.

Precedence: an explicit retention: block wins over the legacy keep_single_release: alias. keep_single_release: true (with no retention) maps to keep_last: 1; false maps to None. A retention.keep_last: 0 is floored to 1 so a retention sweep never deletes the just-created release.

Trait Implementations§

Source§

impl Clone for NightlyConfig

Source§

fn clone(&self) -> NightlyConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NightlyConfig

Source§

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

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

impl Default for NightlyConfig

Source§

fn default() -> NightlyConfig

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

impl<'de> Deserialize<'de> for NightlyConfig

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 JsonSchema for NightlyConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for NightlyConfig

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more