pub struct CitationConfig {
pub title: String,
pub abstract_: String,
pub authors: Vec<CitationAuthor>,
pub message: String,
pub repository_code: String,
pub url: Option<String>,
pub license: Option<String>,
pub date_released: Option<String>,
pub doi: Option<String>,
}Expand description
Configuration for the alef-generated CITATION.cff file at the repo root.
When this section is present in alef.toml, alef sync-versions writes a
fully-rendered Citation File Format YAML using these fields plus the current
workspace version (read from Cargo.toml). When absent, alef falls back to
updating the version: line of a hand-authored CITATION.cff in place.
All field names follow Rust convention; the renderer emits the canonical
CFF kebab-case keys (cff-version, repository-code, date-released,
family-names, given-names).
Fields§
§title: StringSoftware title (title:). Required.
abstract_: StringOne-paragraph summary (abstract:). Required.
Authors list — at least one entry required. Persons and legal entities
can be mixed (e.g. Na'aman Hirschfeld + Kreuzberg, Inc.).
message: StringCanonical citation message shown to consumers (message:).
repository_code: StringSource-code repository URL (repository-code:). Required.
url: Option<String>Project landing-page URL (url:). Optional.
license: Option<String>SPDX license identifier (license:). When omitted, the renderer falls
back to Cargo.toml [workspace.package].license.
date_released: Option<String>Release date in YYYY-MM-DD form (date-released:). Optional.
doi: Option<String>Persistent DOI for the cited release (doi:). Optional.
Trait Implementations§
Source§impl Clone for CitationConfig
impl Clone for CitationConfig
Source§fn clone(&self) -> CitationConfig
fn clone(&self) -> CitationConfig
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more