Release time! (athena-framework/athena#505)

Author: Blacksmoke16

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.4.0] - 2025-01-26
+
+### Changed
+
+- **Breaking:** Normalize exception types ([#428](https://github.com/athena-framework/athena/pull/428)) (George Dietrich)
+
+### Added
+
+- **Breaking:** Add and make `require_tld: true` the default for `AVD::Constraints::URL` ([#492](https://github.com/athena-framework/athena/pull/492)) (George Dietrich)
+- Add example usages to `AVD::Constraints::*` docs ([#483](https://github.com/athena-framework/athena/pull/483), [#493](https://github.com/athena-framework/athena/pull/493)) (Zohir Tamda, George Dietrich)
+
 ## [0.3.4] - 2024-07-31
 
 ### Changed
@@ -152,6 +163,7 @@ _First release a part of the monorepo._
 
 _Initial release._
 
+[0.4.0]: https://github.com/athena-framework/validator/releases/tag/v0.4.0
 [0.3.4]: https://github.com/athena-framework/validator/releases/tag/v0.3.4
 [0.3.3]: https://github.com/athena-framework/validator/releases/tag/v0.3.3
 [0.3.2]: https://github.com/athena-framework/validator/releases/tag/v0.3.2

UPGRADING.md

@@ -0,0 +1,21 @@
+# Upgrading
+
+Documents the changes that may be required when upgrading to a newer component version.
+
+## Upgrade to 0.4.0
+
+### New `AVD::Constraints::URL#require_tld` option
+
+`AVD::Constraints::URL` now requires URLs have a TLD by default; `https://example.com` is valid while `https://example` is not.
+If your logic requires the latter to be considered valid, you will need to ensure `require_tld` is set to `false` on usages of this constraint.
+
+### Normalization of Exception types
+
+The namespace exception types live in has changed from `AVD::Exceptions` to `AVD::Exception`.
+Any usages of `validator` exception types will need to be updated.
+
+Some additional types have also been removed/renamed:
+
+* `AVD::Exceptions::ValidatorError` has been removed in favor of using `AVD::Exception` directly
+
+If using a `rescue` statement with a parent exception type, either from the `validator` component or Crystal stdlib, double check it to ensure it'll still rescue what you are expecting it will.

docs/README.md

@@ -15,7 +15,7 @@ First, install the component by adding the following to your `shard.yml`, then r
 dependencies:
   athena-validator:
     github: athena-framework/validator
-    version: ~> 0.3.0
+    version: ~> 0.4.0
 ```
 
 ## Usage

shard.yml

@@ -1,6 +1,6 @@
 name: athena-validator
 
-version: 0.3.4
+version: 0.4.0
 
 crystal: ~> 1.13
 

src/athena-validator.cr

@@ -34,7 +34,7 @@ module Athena; end
 
 # Provides a robust object/value validation framework.
 module Athena::Validator
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 
   # :nodoc:
   #