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
73
74
75
76
77
78
79
80
81
82

use serde::{
    Deserialize,
    Serialize,
};

use crate::history::RunHistoryPolicy;
use crate::presentation::PluginPresentation;
use crate::schema::{
    ConfigSchema,
    TableSchema,
};
use crate::types::{
    Feature,
    Permission,
};
use crate::utils::{
    provider_type,
    svg_data_url,
};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PluginMetadata {
    pub name: String,
    pub provider_type: String,
    pub version: String,
    pub description: String,
    pub author: Option<String>,
    pub icon: Option<String>,
    pub config_schema: ConfigSchema,
    pub table_schema: TableSchema,
    pub capabilities: PluginCapabilities,
    #[serde(default)]
    pub required_permissions: Vec<Permission>,
    #[serde(default)]
    pub features: Vec<Feature>,
    #[serde(default)]
    pub run_history: RunHistoryPolicy,
    #[serde(default)]
    pub token_prefixes: Vec<String>,
    pub presentation: PluginPresentation,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PluginCapabilities {
    pub trigger: bool,
    pub cancel: bool,
    #[serde(default)]
    pub force_cancel: bool,
    #[serde(default)]
    pub retains_run_history: bool,
    #[serde(default)]
    pub logs: bool,
    #[serde(default)]
    pub sign_in: bool,
    #[serde(default)]
    pub uses_http_proxy: bool,
    #[serde(default)]
    pub async_trigger: bool,
}

#[derive(Debug, Clone, Copy)]
pub struct PluginManifest {
    pub package_name: &'static str,
    pub version: &'static str,
    pub description: &'static str,
    pub authors: &'static str,
    pub icon_svg: &'static str,
}

impl PluginManifest {
    pub fn provider_type(&self) -> &'static str {
        provider_type(self.package_name)
    }

    pub(crate) fn apply(&self, metadata: &mut PluginMetadata) {
        metadata.provider_type = self.provider_type().to_string();
        metadata.version = self.version.to_string();
        metadata.description = self.description.to_string();
        metadata.author = Some(self.authors.to_string());
        metadata.icon = Some(svg_data_url(self.icon_svg));
    }
}