-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCITATION.cff
More file actions
37 lines (37 loc) · 1.49 KB
/
Copy pathCITATION.cff
File metadata and controls
37 lines (37 loc) · 1.49 KB
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
cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
title: "patchnotes: parse, query, and validate software changelogs as structured data"
abstract: >-
patchnotes parses Keep a Changelog markdown and YAML changelogs into typed
Python objects, making the release history of a software project queryable,
diffable, and machine-validatable. It recovers from off-specification input
rather than failing, reports problems as stable diagnostic codes with line
numbers, and renders changelogs to HTML, RSS, JSON, SARIF, and plain text.
A command-line interface, a GitHub Action, pre-commit hooks, and an mkdocs
plugin allow changelog quality to be enforced in continuous integration.
type: software
authors:
- family-names: Chowdhury
given-names: London
orcid: "https://orcid.org/0009-0006-2895-2857"
affiliation: "General Engineering Program, College of Engineering, California Polytechnic State University, San Luis Obispo"
email: "Londopy@protonmail.com"
doi: "10.5281/zenodo.21783509"
identifiers:
- type: doi
value: "10.5281/zenodo.21783509"
description: "Version DOI for the archived 2.5.1 release"
repository-code: "https://github.com/Londopy/patchnotes"
url: "https://github.com/Londopy/patchnotes"
license: MIT
version: 2.5.1
date-released: "2026-08-04"
keywords:
- changelog
- keep a changelog
- semantic versioning
- research software
- software provenance
- reproducibility
- continuous integration
- static analysis