cargo-version-info 0.0.16

Cargo subcommand for unified version management across CI/CD, Rust code, and shell scripts
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

//! Update README with badges.
//!
//! This command injects badges into a README file under the title.
//!
//! # Examples
//!
//! ```bash
//! # Update README.md with badges
//! cargo version-info update-readme
//!
//! # Specify custom README path
//! cargo version-info update-readme --readme docs/README.md
//!
//! # Generate badges first, then inject
//! cargo version-info badge all > badges.md
//! cargo version-info update-readme --badges badges.md
//! ```

use std::path::PathBuf;

use anyhow::Result;
use clap::Parser;

/// Arguments for the `update-readme` command.
#[derive(Parser, Debug)]
pub struct UpdateReadmeArgs {
    /// Path to README file (default: README.md).
    #[arg(long, default_value = "README.md")]
    pub readme: PathBuf,

    /// Path to badges markdown file (default: generate badges on the fly).
    #[arg(long)]
    pub badges: Option<PathBuf>,
}

/// Update README with badges.
///
/// # Note
///
/// This command is currently a stub and not yet implemented. It will be
/// available in a future release.
pub fn update_readme(_args: UpdateReadmeArgs) -> Result<()> {
    anyhow::bail!(
        "README update is not yet implemented. This feature will be available in a future release."
    );
}