Skip to content

Commit

Permalink
Bump versions of sub-components & add changelogs (#178)
Browse files Browse the repository at this point in the history
* Bump versions of sub-components
* Add changelogs to each sub-component
  • Loading branch information
Blacksmoke16 authored May 14, 2022
1 parent 3440d6c commit b3f5d6e
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 4 deletions.
133 changes: 133 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Changelog

## [0.3.0] - 2022-05-14

_First release a part of the monorepo._

### Added

- Add getting started documentation to API docs ([#172](https://github.com/athena-framework/athena/pull/172)) (George Dietrich)

### Changed

- **Breaking:** change serialization of [Enums](https://crystal-lang.org/api/Enum.html) to underscored strings by default ([#173](https://github.com/athena-framework/athena/pull/173)) (George Dietrich)
- Update minimum `crystal` version to `~> 1.4.0` ([#169](https://github.com/athena-framework/athena/pull/169)) (George Dietrich)

### Fixed

- Fix compiler error when trying to deserialize a `Hash` ([#165](https://github.com/athena-framework/athena/pull/165)) (George Dietrich)

## [0.2.10] - 2021-11-12

### Fixed

- Fix issue with empty YAML input ([#22](https://github.com/athena-framework/serializer/pull/22)) (George Dietrich)

## [0.2.9] - 2021-10-30

### Added

- Add `VERSION` constant to `Athena::Serializer` namespace ([#20](https://github.com/athena-framework/serializer/pull/20)) (George Dietrich)

### Fixed

- Fix broken type link ([#19](https://github.com/athena-framework/serializer/pull/19)) (George Dietrich)

## [0.2.8] - 2021-05-17

### Fixed

- Fixes incorrect `nil` check in macro logic ([#17](https://github.com/athena-framework/serializer/pull/17)) (George Dietrich)

## [0.2.7] - 2021-04-09

### Added

- Add some more specialized exception types ([#16](https://github.com/athena-framework/serializer/pull/16)) (George Dietrich)

## [0.2.6] - 2021-03-16

### Added

- Expose a setter for `ASR::Context#version=` ([#15](https://github.com/athena-framework/serializer/pull/15)) (George Dietrich)

### Changed

- Change `athena-framework/config` version constraint to `>= 2.0.0` ([#15](https://github.com/athena-framework/serializer/pull/15)) (George Dietrich)

## [0.2.5] - 2021-01-29

### Changed

- Migrate documentation to [MkDocs](https://mkdocstrings.github.io/crystal/) ([#14](https://github.com/athena-framework/serializer/pull/14)) (George Dietrich)

## [0.2.4] - 2021-01-29

### Changed

- Bump min `athena-framework/config` version to `~> 2.0.0` ([#13](https://github.com/athena-framework/serializer/pull/13)) (George Dietrich)

## [0.2.3] - 2021-01-20

### Fixed

- Fix since/until and group annotations not working for virtual properties ([#12](https://github.com/athena-framework/serializer/pull/12)) (George Dietrich)

## [0.2.2] - 2020-12-03

### Changed

- Update `crystal` version to allow version greater than `1.0.0` ([#11](https://github.com/athena-framework/serializer/pull/11)) (George Dietrich)

## [0.2.1] - 2020-11-08

### Added

- Add deserialization support to `ASRA::Name` ([#9](https://github.com/athena-framework/serializer/pull/9)) (Joakim Repomaa)

## [0.2.0] - 2020-07-08

### Added

- Add dependency on `athena-framework/config` ([#8](https://github.com/athena-framework/serializer/pull/8)) (George Dietrich)
- Add ability to use custom annotations within [exclusion strategies](https://athenaframework.org/Serializer/ExclusionStrategies/ExclusionStrategyInterface/#Athena::Serializer::ExclusionStrategies::ExclusionStrategyInterface--annotation-configurations) ([#8](https://github.com/athena-framework/serializer/pull/8)) (George Dietrich)
- Add [ASR::Context#direction](https://athenaframework.org/Serializer/Context/#Athena::Serializer::Context#direction) to represent which direction the context object represents ([#8](https://github.com/athena-framework/serializer/pull/8)) (George Dietrich)

## [0.1.3] - 2020-07-08

### Fixed

- Fix overflow error when deserializing `Int64` values ([#7](https://github.com/athena-framework/serializer/pull/7)) (George Dietrich)

## [0.1.2] - 2020-07-05

### Added

- Add improved documentation to various types ([#6](https://github.com/athena-framework/serializer/pull/6)) (George Dietrich)

## [0.1.1] - 2020-06-27

### Added

- Add [naming strategies](https://athenaframework.org/Serializer/Annotations/Name/#Athena::Serializer::Annotations::Name--naming-strategies) to `ASRA::Name` ([#5](https://github.com/athena-framework/serializer/pull/5)) (George Dietrich)

## [0.1.0] - 2020-06-23

_Initial release._

[0.3.0]: https://github.com/athena-framework/serializer/releases/tag/v0.3.0
[0.2.10]: https://github.com/athena-framework/serializer/releases/tag/v0.2.10
[0.2.9]: https://github.com/athena-framework/serializer/releases/tag/v0.2.9
[0.2.8]: https://github.com/athena-framework/serializer/releases/tag/v0.2.8
[0.2.7]: https://github.com/athena-framework/serializer/releases/tag/v0.2.7
[0.2.6]: https://github.com/athena-framework/serializer/releases/tag/v0.2.6
[0.2.5]: https://github.com/athena-framework/serializer/releases/tag/v0.2.5
[0.2.4]: https://github.com/athena-framework/serializer/releases/tag/v0.2.4
[0.2.3]: https://github.com/athena-framework/serializer/releases/tag/v0.2.3
[0.2.2]: https://github.com/athena-framework/serializer/releases/tag/v0.2.2
[0.2.1]: https://github.com/athena-framework/serializer/releases/tag/v0.2.1
[0.2.0]: https://github.com/athena-framework/serializer/releases/tag/v0.2.0
[0.1.3]: https://github.com/athena-framework/serializer/releases/tag/v0.1.3
[0.1.2]: https://github.com/athena-framework/serializer/releases/tag/v0.1.2
[0.1.1]: https://github.com/athena-framework/serializer/releases/tag/v0.1.1
[0.1.0]: https://github.com/athena-framework/serializer/releases/tag/v0.1.0
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Serializer

[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)
[![CI](https://github.com/athena-framework/athena/workflows/CI/badge.svg)](https://github.com/athena-framework/athena/actions/workflows/ci.yml)
[![Latest release](https://img.shields.io/github/release/athena-framework/serializer.svg)](https://github.com/athena-framework/serializer/releases)

Expand All @@ -14,7 +15,7 @@ Flexible object (de)serialization library
dependencies:
athena-serializer:
github: athena-framework/serializer
version: ~> 0.2.0
version: ~> 0.3.0
```
2. Run `shards install`
Expand Down
2 changes: 1 addition & 1 deletion shard.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: athena-serializer

version: 0.2.10
version: 0.3.0

crystal: ~> 1.4

Expand Down
4 changes: 2 additions & 2 deletions src/athena-serializer.cr
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ module YAML; end
# dependencies:
# athena-serializer:
# github: athena-framework/serializer
# version: ~> 0.2.0
# version: ~> 0.3.0
# ```
#
# Then run `shards install`, being sure to require it via `require "athena-serializer"`.
Expand Down Expand Up @@ -120,7 +120,7 @@ module YAML; end
# ASR.serializer.serialize obj, :json, ASR::SerializationContext.new.groups = ["details"] # => {"name":"FIRST LAST","title":"title"}
# ```
module Athena::Serializer
VERSION = "0.2.10"
VERSION = "0.3.0"

# Returns an `ASR::SerializerInterface` instance for ad-hoc (de)serialization.
#
Expand Down

0 comments on commit b3f5d6e

Please sign in to comment.