vdev 0.3.1

CLI utilities for Vector (vector.dev) development and CI workflows
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

use crate::utils::git;
use anyhow::{Ok, Result};

/// Check that component documentation is up-to-date
#[derive(clap::Args, Debug)]
#[command()]
pub struct Cli {}

impl Cli {
    pub fn exec(self) -> Result<()> {
        let files: Vec<String> = git::get_modified_files()?;
        let dirty_component_files: Vec<String> = files
            .into_iter()
            .filter(|file| file.starts_with("website/cue/reference"))
            .filter(|file| {
                file.contains("generated/")
                    || file.starts_with("website/cue/reference/remap/functions/")
            })
            .collect();

        // If it is not empty, there are out-of-sync component Cue files in the current branch.
        if !dirty_component_files.is_empty() {
            println!("Found out-of-sync component Cue files in this branch:");
            for file in dirty_component_files {
                println!(" - {file}");
            }
            println!(
                "Run `make generate-docs` locally to update your branch and commit/push the changes."
            );
            std::process::exit(1);
        }

        Ok(())
    }
}