apiforge 0.2.4

Production-grade API release automation CLI. From merged code to healthy pods in production — one command.
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

use std::collections::HashMap;

use async_trait::async_trait;

use crate::config::Config;
use crate::error::Result;

/// Shared context available to every step during validation/execution/rollback.
pub struct StepContext {
    /// Fully resolved release configuration.
    pub config: Config,
    /// Whether the current pipeline run is a dry-run.
    pub dry_run: bool,
    /// Cross-step state bag for lightweight value passing.
    pub state: HashMap<String, String>,
}

#[derive(Debug, Clone)]
/// Result payload emitted by each successful step execution.
pub struct StepOutput {
    /// Final step status.
    pub status: StepStatus,
    /// Human-readable message rendered in CLI output.
    pub message: String,
    /// Execution duration in milliseconds.
    pub duration_ms: u64,
}

impl StepOutput {
    pub fn ok(message: impl Into<String>) -> Self {
        Self {
            status: StepStatus::Success,
            message: message.into(),
            duration_ms: 0,
        }
    }

    pub fn skipped(message: impl Into<String>) -> Self {
        Self {
            status: StepStatus::Skipped,
            message: message.into(),
            duration_ms: 0,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
/// Unified step status values used in run summaries.
pub enum StepStatus {
    Success,
    Skipped,
    Failed,
}

impl std::fmt::Display for StepStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            StepStatus::Success => write!(f, "✓"),
            StepStatus::Skipped => write!(f, "⊘"),
            StepStatus::Failed => write!(f, "✗"),
        }
    }
}

pub mod docker;
pub mod git;
pub mod github;
pub mod health;
pub mod kubernetes;
pub mod notify;

#[async_trait]
/// Contract implemented by all release pipeline steps.
pub trait Step: Send + Sync {
    /// Stable step name used in output and logs.
    fn name(&self) -> &str;
    /// Human-readable summary of what the step does.
    fn description(&self) -> &str;
    /// Validate prerequisites before execution starts.
    async fn validate(&self, ctx: &StepContext) -> Result<()>;
    /// Execute the step in normal mode.
    async fn execute(&self, ctx: &StepContext) -> Result<StepOutput>;
    /// Simulate execution without changing external systems.
    async fn dry_run(&self, ctx: &StepContext) -> Result<StepOutput>;

    /// Attempt to rollback effects of a previously successful execution.
    ///
    /// Default implementation is a no-op for steps that are read-only.
    async fn rollback(&self, _ctx: &StepContext) -> Result<()> {
        Ok(())
    }
}