govctl 0.9.0

Project governance CLI for RFC, ADR, and Work Item management
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

//! Lifecycle command implementations.

use crate::FinalizeStatus;
use crate::cmd::confirmation::confirm_destructive_action;
use crate::config::Config;
use crate::diagnostic::{Diagnostic, DiagnosticCode, DiagnosticResult, Diagnostics};
use crate::write::WriteOp;

mod adr;
mod clause;
mod paths;
mod release;
mod rfc;
mod rfc_clause_versions;
mod rfc_supersede;
pub use adr::{accept_adr, reject_adr, validate_adr_completeness};
pub use release::cut_release;
pub use rfc::{advance, bump, finalize};

/// Deprecate an artifact
///
/// Per [[ADR-0017]], destructive operations require confirmation unless `--force`.
pub fn deprecate(
    config: &Config,
    id: &str,
    force: bool,
    op: WriteOp,
) -> DiagnosticResult<Diagnostics> {
    if !confirm_destructive_action(
        force,
        op,
        &format!("Deprecate {}?", id),
        "Deprecation cancelled",
    )? {
        return Ok(vec![]);
    }

    if id.contains(':') {
        clause::deprecate_clause(config, id, op)
    } else if id.starts_with("RFC-") {
        finalize(config, id, FinalizeStatus::Deprecated, op)
    } else if id.starts_with("ADR-") {
        Err(Diagnostic::new(
            DiagnosticCode::E0305AdrCannotDeprecate,
            format!(
                "ADRs cannot be deprecated. Use `govctl supersede {id} --by ADR-XXXX` instead."
            ),
            id,
        ))
    } else {
        Err(Diagnostic::new(
            DiagnosticCode::E0813SupersedeNotSupported,
            format!("Unknown artifact type: {id}"),
            id,
        ))
    }
}

/// Supersede an artifact
///
/// Per [[ADR-0017]], destructive operations require confirmation unless `--force`.
pub fn supersede(
    config: &Config,
    id: &str,
    by: &str,
    force: bool,
    op: WriteOp,
) -> DiagnosticResult<Diagnostics> {
    if !confirm_destructive_action(
        force,
        op,
        &format!("Supersede {} with {}?", id, by),
        "Supersede cancelled",
    )? {
        return Ok(vec![]);
    }

    if id.contains(':') {
        clause::supersede_clause(config, id, by, op)
    } else if id.starts_with("RFC-") {
        rfc_supersede::supersede_rfc(config, id, by, op)
    } else if id.starts_with("ADR-") {
        adr::supersede_adr(config, id, by, op)
    } else {
        Err(Diagnostic::new(
            DiagnosticCode::E0813SupersedeNotSupported,
            format!("Supersede is not supported for this artifact type: {id}"),
            id,
        ))
    }
}