Struct GithubHostLayer 

pub struct GithubHostLayer {
    pub common: CommonHostLayer,
    pub create: Option<bool>,
    pub repo: Option<GithubRepoPair>,
    pub submodule_path: Option<Utf8PathBuf>,
    pub during: Option<GithubReleasePhase>,
    pub attestations: Option<bool>,
    pub attestations_filters: Option<GithubAttestationsFilters>,
    pub attestations_phase: Option<GithubAttestationsPhase>,
}

github host config (raw)

Fields

common: CommonHostLayer

Common options

create: Option<bool>

Whether we should create the Github Release for you when you push a tag.

If true (default), dist will create a new Github Release and generate a title/body for it based on your changelog.

If false, dist will assume a draft Github Release already exists with the title/body you want. At the end of a successful publish it will undraft the Github Release.

repo: Option<GithubRepoPair>

Publish GitHub Releases to this repo instead of the current one

The user must also set GH_RELEASES_TOKEN in their SECRETS

submodule_path: Option<Utf8PathBuf>

If repo is used, the commit ref to used will be read from the HEAD of the submodule at this path

during: Option<GithubReleasePhase>

Which phase to create the github release in

attestations: Option<bool>

Whether GitHub Attestations is enabled (default false)

attestations_filters: Option<GithubAttestationsFilters>

GitHub Attestation filters (default *)

attestations_phase: Option<GithubAttestationsPhase>

When to generate GitHub Attestations (default build-local-artifacts)

Trait Implementations

impl ApplyLayer for GithubHostLayer

type Layer = GithubHostLayer

The much more Option-ridden version of this config that can be repeatedly layerd with options

fn apply_layer(&mut self, _: Self::Layer)

Merges this value with another layer of itself, preferring the new layer

fn apply_val_layer(&mut self, layer: Option<Self::Layer>)

Merges this value with another layer of itself, preferring the new layer

impl Clone for GithubHostLayer

fn clone(&self) -> GithubHostLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GithubHostLayer

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

Formats the value using the given formatter.

impl Default for GithubHostLayer

fn default() -> GithubHostLayer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GithubHostLayer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GithubHostLayer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.