From 3cef6c393d3e42820b5268893e7c7c8a3a0ad224 Mon Sep 17 00:00:00 2001 From: Anders Goncalves da Silva Date: Fri, 17 Mar 2023 14:45:10 -0700 Subject: [PATCH] Add changelog --- CHANGELOG.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7e725fb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +cl-# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog], +and this project adheres to [Semantic Versioning]. + +## [Unreleased] + +### Added + +- Regex to parse version string from a larger string, and allowing for optional path number +- Parse function that takes a string and returns a semver.VersionInfo object +- Verify function that takes a expected version and a version requirement and returns a tuple with boolean and the observed version +- get_version function that takes a path to a tool and a version flag and returns the version string +- verify_from_config function that takes a path to a config file in YAML format, and checks each tool's version against the requirements. This is the main function of the library +- README.md +- Example code to show how to use the library +