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
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Generate docs.rs badge.

use std::io::Write;

use anyhow::{
    Context,
    Result,
};

use super::common::guess_if_published;

/// Check if crate is published on docs.rs.
///
/// Uses HTTP request when `no_network` is false, otherwise uses heuristics.
async fn is_published_on_docs_rs(
    package_name: &str,
    package: &cargo_metadata::Package,
    no_network: bool,
) -> Result<bool> {
    if no_network {
        guess_if_published(package).await
    } else {
        let docs_url = format!("https://docs.rs/{}", package_name);
        let client = reqwest::Client::builder()
            .timeout(std::time::Duration::from_secs(5))
            .build()
            .context("Failed to create HTTP client")?;

        let response = client
            .head(&docs_url)
            .send()
            .await
            .context("Failed to check docs.rs")?;

        Ok(response.status().is_success())
    }
}

/// Show the docs.rs badge if the project is published there.
pub async fn badge_rustdocs(
    writer: &mut dyn Write,
    package: &cargo_metadata::Package,
    no_network: bool,
) -> Result<()> {
    let mut logger = cargo_plugin_utils::logger::Logger::new();
    logger.status("Generating", "docs.rs badge");

    let package_name = &package.name;

    if is_published_on_docs_rs(package_name, package, no_network).await? {
        let badge_url = format!("https://img.shields.io/docsrs/{}", package_name);
        let badge_markdown = format!(
            "[![docs.rs]({})](https://docs.rs/{})",
            badge_url, package_name
        );
        writeln!(writer, "{}", badge_markdown)?;
    }

    Ok(())
}