From 0c9d4ba3e544b5b32f44c6c53269ffbe86b68d6d Mon Sep 17 00:00:00 2001 From: George Dietrich Date: Wed, 31 Jul 2024 13:29:13 -0400 Subject: [PATCH] Release time! (#434) * Bump `console` component * Bump `dependency_injection` component * Bump `dotenv` component * Bump `framework` component * Bump `spec` component * Bump `validator` component --- CHANGELOG.md | 10 ++++++++++ UPGRADING.md | 8 ++++++++ shard.yml | 2 +- src/athena-console.cr | 2 +- 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 10d88a2..6e64828 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [0.3.6] - 2024-07-31 + +### Changed + +- **Breaking:** `ACON::Application#getter` and constructor argument must now be a `String` instead of `SemanticVersion` ([#419](https://github.com/athena-framework/athena/pull/419)) (George Dietrich) +- Changed the default `ACON::Application` version to `UNKNOWN` from `0.1.0` ([#419](https://github.com/athena-framework/athena/pull/419)) (George Dietrich) +- List commands in a namespace when using it as the command name ([#427](https://github.com/athena-framework/athena/pull/427)) (George Dietrich) +- Use single quotes in text descriptor to quote values in the output ([#427](https://github.com/athena-framework/athena/pull/427)) (George Dietrich) + ## [0.3.5] - 2024-04-09 ### Changed @@ -121,6 +130,7 @@ _First release a part of the monorepo._ _Initial release._ +[0.3.6]: https://github.com/athena-framework/console/releases/tag/v0.3.6 [0.3.5]: https://github.com/athena-framework/console/releases/tag/v0.3.5 [0.3.4]: https://github.com/athena-framework/console/releases/tag/v0.3.4 [0.3.3]: https://github.com/athena-framework/console/releases/tag/v0.3.3 diff --git a/UPGRADING.md b/UPGRADING.md index 9e11fa3..b11c8f8 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,6 +2,14 @@ Documents the changes that may be required when upgrading to a newer component version. +## Upgrade to 0.3.6 + +### `ACON::Application` version is now represented as a `String` + +If passing a [SemanticVersion](https://crystal-lang.org/api/SemanticVersion.html) as the *version* of an `ACON::Application`, call `#to_s` on it or ideally pass a semver `String` directly. +If using the `#version` getter off the `ACON::Application`, your code will either need to adapt to it now being a `String`. +Either by manually constructing a `SemanticVersion` or ideally just supporting the returned `String`. + ## Upgrade to 0.3.3 ### New `ACON::Style::Interface` methods diff --git a/shard.yml b/shard.yml index f914f39..911d246 100644 --- a/shard.yml +++ b/shard.yml @@ -1,6 +1,6 @@ name: athena-console -version: 0.3.5 +version: 0.3.6 crystal: ~> 1.11 diff --git a/src/athena-console.cr b/src/athena-console.cr index 36d579d..9a50f7d 100644 --- a/src/athena-console.cr +++ b/src/athena-console.cr @@ -29,7 +29,7 @@ alias ACONA = ACON::Annotations # Allows the creation of CLI based commands module Athena::Console - VERSION = "0.3.5" + VERSION = "0.3.6" # Contains all the `Athena::Console` based annotations. module Annotations; end