pipedash-plugin-api 0.14.0

Plugin API for Pipedash - CI/CD pipeline dashboard
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

use serde::{
    Deserialize,
    Serialize,
};

use crate::presentation::DisplayField;

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct ActionAvailability {
    pub allowed: bool,
    pub reason: Option<String>,
}

impl ActionAvailability {
    pub fn allowed(allowed: bool) -> Self {
        Self {
            allowed,
            reason: None,
        }
    }

    pub fn blocked(reason: impl Into<String>) -> Self {
        Self {
            allowed: false,
            reason: Some(reason.into()),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum RerunStrategy {
    InPlace,
    #[default]
    ReplayInputs,
    ReconcileCurrent,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum ActionIcon {
    #[default]
    Play,
    Refresh,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct PipelineActionState {
    pub trigger: ActionAvailability,
    pub cancel: ActionAvailability,
    pub force_cancel: ActionAvailability,
    pub enable: ActionAvailability,
    pub rerun_strategy: RerunStrategy,
    pub trigger_icon: ActionIcon,
    pub target: Option<DisplayField>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct RunActionState {
    pub cancel: ActionAvailability,
    pub force_cancel: ActionAvailability,
    pub rerun: ActionAvailability,
    pub rerun_failed: ActionAvailability,
    pub review: ActionAvailability,
    pub watch: bool,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct TriggerResult {
    pub run_id: Option<String>,
    pub run_number: Option<i64>,
}