Skip to content

Report structured metadata from CITATION.cff files - #193

Merged
andrew merged 1 commit into
mainfrom
citation-metadata
Sep 21, 2026
Merged

andrew merged 1 commit into
mainfrom
citation-metadata

Conversation

@andrew

@andrew andrew commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

CITATION.cff currently contributes only a file path to the report. Use github.com/git-pkgs/citation to add structured authors, release details, identifiers, and preferred citations under resources.citation, while preserving resources.metadata.citation.

Human and Markdown reports include a bounded citation summary, with more metadata in verbose output. Parsing and validation have separate statuses so invalid or older files can retain useful metadata. Read errors, malformed YAML, and parser limits produce diagnostics without failing the scan. Citation metadata also follows changed-file filtering in brief diff.

Example output from brief --human testdata/citation-project:

Metadata:    CITATION.cff
Citation:      Example Research Software
Authors:       Alex van Example III, Research Team
Release:       1.20 2024-02-29
DOI:           10.1234/software
Identifier:    doi 10.1234/archive Archived releases
Cite:          The accompanying paper
Preferred DOI: 10.1234/paper
CFF:           1.2.0 valid

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@andrew
andrew merged commit dddbfd2 into main Sep 21, 2026
8 of 9 checks passed
@andrew
andrew deleted the citation-metadata branch September 21, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants