diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e02953..08e3589 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,3 +17,37 @@ focus on the user impact** rather than the actual changes made. ## Removed ## Fixed ## Security + +# Herostratus - 0.1.0-rc1 - (2024-04-07) +This is the first release of Herostratus! This release is largely centered around project +bootstrapping; Herostratus isn't quite ready to use yet. + +## Added +* Cargo project bootstrapping. You can run Herostratus with + + ```sh + cargo run -- $CLONE_URL_OR_PATH $REF_OR_REV + ``` + * `$CLONE_URL_OR_PATH` can be any non-authenticated clone URL (https, or local file paths) + * `$REF_OR_REV` is typically the name of a reference to parse. Herostratus will resolve the + reference to a revision, and visit all reachable commits from the revision. + + The output is pretty bare bones. There's only a single achievement rule defined for prototyping + purposes. + + For example, you can run Herostratus on itself, using the + test branch + ```sh + $ cargo run -- . origin/test/fixup + Achievement { name: "I meant to fix that up later, I swear!", commit: 2721748d8fa0b0cc3302b41733d37e30161eabfd } + Achievement { name: "I meant to fix that up later, I swear!", commit: a987013884fc7dafbe9eb080d7cbc8625408a85f } + Achievement { name: "I meant to fix that up later, I swear!", commit: 60b480b554dbd5266eec0f2378f72df5170a6702 } + ``` + +* Automated CI/CD pipelines to build, test, and release Herostratus. + + The process to create a release is: + 1. Add release notes to the `CHANGELOG.md` + 2. Bump the version in `Cargo.toml` + + and the pipeline will do the rest! diff --git a/Cargo.lock b/Cargo.lock index 98cdbb3..8fb3e08 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -344,7 +344,7 @@ checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" [[package]] name = "herostratus" -version = "0.1.0" +version = "0.1.0-rc1" dependencies = [ "assert_cmd", "clap", diff --git a/Cargo.toml b/Cargo.toml index aa32056..27b1573 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,9 @@ [package] name = "herostratus" -description = "An ancient Greek known for winning fame through crime and destruction. Also a Git repository achievements engine" +description = "**Herostratus** *n.* **1.** An ancient Greek known for winning fame through crime and destruction. **2.** Also a Git repository achievements engine." repository = "https://github.com/Notgnoshi/herostratus" license = "MIT" -version = "0.1.0" +version = "0.1.0-rc1" edition = "2021" [dependencies]