ferrflow 7.16.0

Universal semantic versioning for monorepos and classic repos
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
#[serde(rename_all = "lowercase")]
pub enum ForgeKind {
    #[default]
    Auto,
    #[serde(alias = "GitHub")]
    Github,
    #[serde(alias = "GitLab")]
    Gitlab,
    #[serde(alias = "Gitea", alias = "forgejo", alias = "Forgejo")]
    Gitea,
    #[serde(alias = "Bitbucket")]
    Bitbucket,
}

pub const GENERIC_TOKEN_ENV_VAR: &str = "FERRFLOW_TOKEN";

impl ForgeKind {
    pub const ALL: &'static [Self] = &[Self::Github, Self::Gitlab, Self::Gitea, Self::Bitbucket];

    pub fn token_env_vars(self) -> &'static [&'static str] {
        match self {
            Self::Github => &["GITHUB_TOKEN"],
            Self::Gitlab => &["GITLAB_TOKEN"],
            Self::Gitea => &["GITEA_TOKEN", "FORGEJO_TOKEN"],
            Self::Bitbucket => &["BITBUCKET_TOKEN"],
            Self::Auto => &[],
        }
    }
}

pub fn all_token_env_vars() -> impl Iterator<Item = &'static str> {
    std::iter::once(GENERIC_TOKEN_ENV_VAR).chain(
        ForgeKind::ALL
            .iter()
            .flat_map(|kind| kind.token_env_vars().iter().copied()),
    )
}

#[derive(Debug, Deserialize, Serialize, Clone, Default)]
pub struct HooksConfig {
    #[serde(alias = "preBump")]
    pub pre_bump: Option<String>,
    #[serde(alias = "postBump")]
    pub post_bump: Option<String>,
    #[serde(alias = "preCommit")]
    pub pre_commit: Option<String>,
    #[serde(alias = "postCommit")]
    pub post_commit: Option<String>,
    #[serde(alias = "preTag")]
    pub pre_tag: Option<String>,
    #[serde(alias = "postTag")]
    pub post_tag: Option<String>,
    #[serde(alias = "prePublish")]
    pub pre_publish: Option<String>,
    #[serde(alias = "postPublish")]
    pub post_publish: Option<String>,
    #[serde(alias = "preRelease")]
    pub pre_release: Option<String>,
    #[serde(alias = "onSuccess")]
    pub on_success: Option<String>,
    #[serde(alias = "onError")]
    pub on_error: Option<String>,
    #[serde(default, alias = "onFailure")]
    pub on_failure: Option<OnFailure>,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "lowercase")]
pub enum OnFailure {
    #[default]
    Abort,
    Continue,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Eq, Default)]
#[serde(rename_all = "camelCase")]
pub enum VersionSourcePolicy {
    #[default]
    Highest,
    Tag,
    File,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "camelCase")]
pub enum OrphanedTagStrategy {
    #[default]
    Warn,
    TreeHash,
    Message,
}

#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct BranchChannelConfig {
    pub name: String,
    #[serde(default)]
    pub channel: ChannelValue,
    #[serde(default, alias = "prereleaseIdentifier")]
    pub prerelease_identifier: PrereleaseIdentifier,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ChannelValue {
    Stable(bool),
    Named(String),
}

impl Default for ChannelValue {
    fn default() -> Self {
        ChannelValue::Stable(false)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize, Default)]
#[serde(rename_all = "kebab-case")]
pub enum PrereleaseIdentifier {
    #[default]
    Increment,
    Timestamp,
    ShortHash,
    TimestampHash,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum ReleaseCommitMode {
    #[default]
    Commit,
    Pr,
    None,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum ReleaseCommitScope {
    #[default]
    Grouped,
    PerPackage,
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum ReleaseCommitBody {
    #[default]
    None,
    Summary,
    Full,
}

/// Declarative registry-credential map shared across every publisher
/// kind. Lets users say "the Kellnr registry's token is in
/// CARGO_REGISTRIES_KELLNR_TOKEN" once at the workspace level instead
/// of restating it on every package's publisher entry.
///
/// `tokenEnv` is the env-var name (not the value) — the actual token
/// stays in the runner's secret store. `url` is informational and used
/// for the dry-run preview message + future idempotency probes.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Default)]
pub struct RegistryConfig {
    #[serde(default)]
    pub url: Option<String>,
    #[serde(alias = "tokenEnv")]
    pub token_env: Option<String>,
}

/// Declarative replacement for the shell-soup that currently lives in
/// `postPublish` hooks across every FerrLabs cloud repo. Each
/// publisher is a self-contained intent ("push this package to that
/// registry"), evaluated in declaration order after the release
/// commit + tag + GitHub Release have been created. v1 ships parsing
/// and dry-run preview only — actual publish execution lands in
/// follow-up PRs (one publisher kind per PR) so the schema can be
/// reviewed before any side-effecting code does.
///
/// The kind is the externally-tagged discriminator (`{"kind":
/// "cargo", ...}`) — keeps the JSON Schema readable and lets us add
/// kinds without overloading existing fields.
fn default_true() -> bool {
    true
}

#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
#[serde(tag = "kind", rename_all = "kebab-case")]
pub enum PublisherConfig {
    Cargo {
        #[serde(default)]
        registry: Option<String>,
        #[serde(default, rename = "allowDirty", alias = "allow_dirty")]
        allow_dirty: bool,
        #[serde(default, rename = "noVerify", alias = "no_verify")]
        no_verify: bool,
        #[serde(default)]
        args: Vec<String>,
    },
    Npm {
        #[serde(default)]
        registry: Option<String>,
        #[serde(default)]
        tag: Option<String>,
        #[serde(default)]
        access: Option<String>,
        #[serde(default)]
        args: Vec<String>,
    },
    Docker {
        image: String,
        #[serde(default = "default_docker_tags")]
        tags: Vec<String>,
        #[serde(default)]
        platforms: Vec<String>,
        #[serde(default = "default_docker_context")]
        context: String,
        #[serde(default = "default_dockerfile")]
        dockerfile: String,
        #[serde(default)]
        sign: DockerSign,
        #[serde(default)]
        args: Vec<String>,
    },
    Helm {
        #[serde(default = "default_helm_chart_path")]
        chart: String,
        registry: String,
        #[serde(default)]
        args: Vec<String>,
    },
    GithubReleaseAsset {
        path: String,
        #[serde(default, rename = "displayName", alias = "display_name")]
        display_name: Option<String>,
        #[serde(default)]
        args: Vec<String>,
    },
    Pypi {
        #[serde(default)]
        registry: Option<String>,
        #[serde(default = "default_true")]
        build: bool,
        #[serde(default, rename = "trustedPublishing", alias = "trusted_publishing")]
        trusted_publishing: bool,
        #[serde(default)]
        args: Vec<String>,
    },
    Webhook {
        url: String,
        #[serde(default)]
        body: Option<serde_json::Value>,
        #[serde(default)]
        headers: std::collections::BTreeMap<String, String>,
    },
}

#[derive(Debug, Deserialize, Serialize, Clone, Copy, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum DockerSign {
    #[default]
    None,
    Sigstore,
}

fn default_docker_tags() -> Vec<String> {
    vec!["{version}".to_string()]
}

fn default_docker_context() -> String {
    ".".to_string()
}

fn default_dockerfile() -> String {
    "Dockerfile".to_string()
}

fn default_helm_chart_path() -> String {
    ".".to_string()
}

impl PublisherConfig {
    /// Whether a successful publish through this publisher cannot be undone.
    ///
    /// crates.io never removes a version (yanking hides it, the artefact stays),
    /// PyPI is the same, and npm refuses to republish an unpublished version.
    /// Rolling a release back past one of these would delete the tag for a
    /// version anyone can still install, so `ferrflow rollback` stops instead.
    /// Docker tags, Helm charts, release assets and webhooks are all replaceable.
    pub fn is_immutable_publish(&self) -> bool {
        matches!(
            self,
            PublisherConfig::Cargo { .. }
                | PublisherConfig::Npm { .. }
                | PublisherConfig::Pypi { .. }
        )
    }

    /// Short human-friendly name (`"cargo"`, `"docker"`, …) for log
    /// lines, dry-run output, and step summaries. Stable enough to be
    /// pattern-matched in CI scripts.
    pub fn kind_name(&self) -> &'static str {
        match self {
            PublisherConfig::Cargo { .. } => "cargo",
            PublisherConfig::Npm { .. } => "npm",
            PublisherConfig::Docker { .. } => "docker",
            PublisherConfig::Helm { .. } => "helm",
            PublisherConfig::GithubReleaseAsset { .. } => "github-release-asset",
            PublisherConfig::Pypi { .. } => "pypi",
            PublisherConfig::Webhook { .. } => "webhook",
        }
    }

    /// One-line description for the dry-run preview ("would publish
    /// X to Y"). Resolves placeholders that only depend on per-call
    /// inputs (name + new version); registry-level fields stay
    /// unresolved at this stage.
    pub fn describe(&self, package_name: &str, new_version: &str) -> String {
        match self {
            PublisherConfig::Cargo { registry, .. } => {
                let reg = registry.as_deref().unwrap_or("crates-io");
                format!("cargo publish {package_name}@{new_version}{reg}")
            }
            PublisherConfig::Pypi { registry, .. } => {
                let reg = registry.as_deref().unwrap_or("pypi.org");
                format!("twine upload {package_name}@{new_version}{reg}")
            }
            PublisherConfig::Npm { registry, tag, .. } => {
                let reg = registry.as_deref().unwrap_or("npmjs.org");
                let tag = tag.as_deref().unwrap_or("latest");
                format!("npm publish {package_name}@{new_version}{reg} (tag={tag})")
            }
            PublisherConfig::Docker {
                image,
                tags,
                platforms,
                sign,
                ..
            } => {
                let resolved: Vec<String> = tags
                    .iter()
                    .map(|t| t.replace("{version}", new_version))
                    .collect();
                let platforms_s = if platforms.is_empty() {
                    "linux/amd64".to_string()
                } else {
                    platforms.join(",")
                };
                let sign_s = match sign {
                    DockerSign::None => "",
                    DockerSign::Sigstore => " +sigstore",
                };
                format!(
                    "docker push {image}:[{}] platforms={platforms_s}{sign_s}",
                    resolved.join(", ")
                )
            }
            PublisherConfig::Helm {
                chart, registry, ..
            } => {
                format!("helm push {chart} {new_version}{registry}")
            }
            PublisherConfig::GithubReleaseAsset {
                path, display_name, ..
            } => {
                let shown = display_name.as_deref().unwrap_or(path);
                format!("upload {shown} → GitHub Release {new_version}")
            }
            PublisherConfig::Webhook { url, .. } => {
                format!("POST {url} ({package_name}@{new_version})")
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::PublisherConfig;

    fn parse(json: &str) -> PublisherConfig {
        serde_json::from_str(json).expect("publisher must deserialize")
    }

    #[test]
    fn the_cargo_publisher_accepts_both_spellings() {
        assert_eq!(
            parse(r#"{"kind":"cargo","allowDirty":true,"noVerify":true}"#),
            parse(r#"{"kind":"cargo","allow_dirty":true,"no_verify":true}"#)
        );
    }

    #[test]
    fn a_release_asset_display_name_accepts_both_spellings() {
        assert_eq!(
            parse(r#"{"kind":"github-release-asset","path":"sbom.json","displayName":"sbom"}"#),
            parse(r#"{"kind":"github-release-asset","path":"sbom.json","display_name":"sbom"}"#)
        );
    }

    #[test]
    fn the_pypi_publisher_accepts_both_spellings() {
        assert_eq!(
            parse(r#"{"kind":"pypi","trustedPublishing":true}"#),
            parse(r#"{"kind":"pypi","trusted_publishing":true}"#)
        );
    }

    #[test]
    fn a_snake_case_flag_is_not_silently_dropped() {
        let PublisherConfig::Cargo { no_verify, .. } =
            parse(r#"{"kind":"cargo","no_verify":true}"#)
        else {
            panic!("expected a cargo publisher");
        };
        assert!(
            no_verify,
            "no_verify must reach the publisher, not default to false"
        );
    }

    #[test]
    fn publishers_still_serialize_in_camel_case() {
        let json = serde_json::to_string(&parse(r#"{"kind":"cargo","allow_dirty":true}"#)).unwrap();
        assert!(json.contains("allowDirty"), "got: {json}");
    }
}