peach-devdocs/src/software/utilities/peach-version-checker.md

1.1 KiB

peach-version-checker

GitHub logo Version badge

A simple commandline tool which helps to ensure version consistency across software and documentation.

peach-version-checker compares version numbers in crate READMEs, manifests and developer documentation for each microservice and program in the PeachCloud ecosystem. Each program is given a passing or failing grade in the generated report. Project maintainers can then act accordingly if any version inconsistencies are found.

Usage

git clone git@github.com:peachcloud/peach-version-checker.git
cd peach-version-checker
cargo build --release
./release/target/peach-version-checker

Example Output

[ peach-buttons  ]
Dev-docs: 0.1.3
Manifest: 0.1.3
Readme  : 0.1.3
PASS
[ peach-oled  ]
Dev-docs: 0.1.0
Manifest: 0.1.3
Readme  : 0.1.3
FAIL
[ peach-probe  ]
Dev-docs: No version number found
Manifest: 0.1.1
Readme  : 0.1.1
FAIL

Licensing

AGPL-3.0