gl-env 0.1.0

Bulk-edit Group- and Project-level CI/CD variables in GitLab.
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

//! Definition of the command-line interfaces.
//!
//! Doc-comments in this file will likely show up in a help text.

use clap::{Args, Parser, Subcommand};
use url::Url;

/// Tools to bulk-edit Project-level CI/CD variables in GitLab.
#[derive(Parser)]
#[command(version, about, long_about = None)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand)]
pub enum Commands {
    /// List all configured CI/CD variables
    ///
    /// Output columns: Key, Environment, Masked, Protected, Raw
    List(CommonArgs),

    /// Show a diff between actual and desired variables
    Diff(CommonArgs),

    /// Dump the current variables
    Dump(CommonArgs),

    /// Apply desired variables
    Apply {
        #[clap(flatten)]
        args: CommonArgs,

        /// Print what WOULD been done, but don't actually do it
        #[arg(short, long)]
        dry_run: bool,

        /// Remove variables not present in desired state
        #[arg(long)]
        prune: bool,
    },
}

/// Arguments shared between all commands
#[derive(Args)]
pub struct CommonArgs {
    /// Base URL of the GitLab instance.
    #[arg(
        short,
        long,
        default_value = "https://gitlab.com",
        global = true,
        env = "GITLAB_URL"
    )]
    pub url: Url,

    /// Personal Access Token.
    ///
    /// Required scopes: `api`.
    #[arg(short, long, env = "GITLAB_TOKEN", hide_env_values = true)]
    pub token: String,

    /// Path/ID of the project (either `mygroup/myproject` or numeric Project ID).
    #[arg(short, long)]
    pub project: Option<String>,

    /// Path/ID of the group (either `mygroup` or numeric Group ID).
    #[arg(short, long)]
    pub group: Option<String>,
}