cargo-dist 0.32.0

Shippable application packaging for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! github host

use super::*;

/// github host config (raw)
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct GithubHostLayer {
    /// Common options
    #[serde(flatten)]
    pub common: CommonHostLayer,

    /// 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.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub create: Option<bool>,

    /// Publish GitHub Releases to this repo instead of the current one
    ///
    /// The user must also set GH_RELEASES_TOKEN in their SECRETS
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo: Option<GithubRepoPair>,

    /// If `repo` is used, the commit ref to used will
    /// be read from the HEAD of the submodule at this path
    #[serde(skip_serializing_if = "Option::is_none")]
    pub submodule_path: Option<Utf8PathBuf>,

    /// Which phase to create the github release in
    #[serde(skip_serializing_if = "Option::is_none")]
    pub during: Option<GithubReleasePhase>,

    /// Whether GitHub Attestations is enabled (default false)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attestations: Option<bool>,

    /// GitHub Attestation filters (default *)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attestations_filters: Option<GithubAttestationsFilters>,

    /// When to generate GitHub Attestations (default build-local-artifacts)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attestations_phase: Option<GithubAttestationsPhase>,
}
/// github host config (final)
#[derive(Debug, Default, Clone)]
pub struct GithubHostConfig {
    /// Common options
    pub common: CommonHostConfig,
    /// Whether we should create the Github Release for you
    pub create: bool,
    /// Publish GitHub Releases to this repo instead of the current one
    pub repo: Option<GithubRepoPair>,
    /// If github-releases-repo is used, the commit ref to used will
    /// be read from the HEAD of the submodule at this path
    pub submodule_path: Option<Utf8PathBuf>,
    /// Which phase to create the github release in
    pub during: GithubReleasePhase,
    /// Whether GitHub Attestations is enabled (default false)
    pub attestations: bool,
    /// GitHub Attestation filters (default *)
    pub attestations_filters: GithubAttestationsFilters,
    /// When to generate GitHub Attestations (default build-local-artifacts)
    pub attestations_phase: GithubAttestationsPhase,
}

impl GithubHostConfig {
    /// Get defaults for the given package
    pub fn defaults_for_workspace(_workspaces: &WorkspaceGraph, common: &CommonHostConfig) -> Self {
        Self {
            common: common.clone(),
            create: true,
            repo: None,
            submodule_path: None,
            during: GithubReleasePhase::default(),
            attestations: false,
            attestations_filters: GithubAttestationsFilters::default(),
            attestations_phase: GithubAttestationsPhase::default(),
        }
    }
}

impl ApplyLayer for GithubHostConfig {
    type Layer = GithubHostLayer;
    fn apply_layer(
        &mut self,
        Self::Layer {
            common,
            create,
            repo,
            submodule_path,
            during,
            attestations,
            attestations_filters,
            attestations_phase,
        }: Self::Layer,
    ) {
        self.common.apply_layer(common);
        self.create.apply_val(create);
        self.repo.apply_opt(repo);
        self.submodule_path.apply_opt(submodule_path);
        self.during.apply_val(during);
        self.attestations.apply_val(attestations);
        self.attestations_filters.apply_val(attestations_filters);
        self.attestations_phase.apply_val(attestations_phase);
    }
}
impl ApplyLayer for GithubHostLayer {
    type Layer = GithubHostLayer;
    fn apply_layer(
        &mut self,
        Self::Layer {
            common,
            create,
            repo,
            submodule_path,
            during,
            attestations,
            attestations_filters,
            attestations_phase,
        }: Self::Layer,
    ) {
        self.common.apply_layer(common);
        self.create.apply_opt(create);
        self.repo.apply_opt(repo);
        self.submodule_path.apply_opt(submodule_path);
        self.during.apply_opt(during);
        self.attestations.apply_opt(attestations);
        self.attestations_filters.apply_opt(attestations_filters);
        self.attestations_phase.apply_opt(attestations_phase);
    }
}

impl std::ops::Deref for GithubHostConfig {
    type Target = CommonHostConfig;
    fn deref(&self) -> &Self::Target {
        &self.common
    }
}