gx 0.8.0

CLI to manage Github Actions dependencies
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

use super::{Context, Diagnostic, Rule, RuleName};
use crate::config::Level;
use std::collections::HashSet;

/// unsynced-manifest rule: detects when manifest and workflows have different action sets.
pub struct UnsyncedManifestRule;

impl Rule for UnsyncedManifestRule {
    fn name(&self) -> RuleName {
        RuleName::UnsyncedManifest
    }

    fn default_level(&self) -> Level {
        Level::Error
    }

    fn check(&self, ctx: &Context) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        let workflow_actions: HashSet<_> = ctx.action_set.action_ids().cloned().collect();
        let manifest_actions: HashSet<_> = ctx.manifest.specs().map(|s| s.id.clone()).collect();

        // Actions in workflows but not in manifest
        for action_id in workflow_actions.difference(&manifest_actions) {
            let msg = format!(
                "action {action_id} is used in workflows but not declared in manifest (gx.toml)"
            );
            diagnostics.push(Diagnostic::new(
                RuleName::UnsyncedManifest,
                self.default_level(),
                msg,
            ));
        }

        // Actions in manifest but not in any workflow
        for action_id in manifest_actions.difference(&workflow_actions) {
            let msg = format!(
                "action {action_id} is declared in manifest (gx.toml) but not used in any workflow"
            );
            diagnostics.push(Diagnostic::new(
                RuleName::UnsyncedManifest,
                self.default_level(),
                msg,
            ));
        }

        diagnostics
    }
}

#[cfg(test)]
mod tests {
    use super::{Level, Rule as _, RuleName, UnsyncedManifestRule};

    #[test]
    fn unsynced_manifest_rule_has_correct_metadata() {
        let rule = UnsyncedManifestRule;
        assert_eq!(rule.name(), RuleName::UnsyncedManifest);
        assert_eq!(rule.default_level(), Level::Error);
    }
}