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 dc01af3 commit 1aeee53
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 4 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog

## [0.2.0] - 2022-05-14

_First release a part of the monorepo._

### Added

- Add `VERSION` constant to `Athena::Console` namespace ([#166](https://github.com/athena-framework/athena/pull/166)) (George Dietrich)
- Add getting started documentation to API docs ([#172](https://github.com/athena-framework/athena/pull/172)) (George Dietrich)

### Changed

- Update minimum `crystal` version to `~> 1.4.0` ([#169](https://github.com/athena-framework/athena/pull/169)) (George Dietrich)
- **Breaking:** remove `ACON::Formatter::Mode` in favor of `Colorize::Mode` ([#170](https://github.com/athena-framework/athena/pull/170)) (George Dietrich). Breaking only if not using symbol autocasting.

### Fixed

- Disallow multi char option shortcuts made up of diff chars ([#164](https://github.com/athena-framework/athena/pull/164)) (George Dietrich)

## [0.1.1] - 2021-12-01

### Fixed

- Fix recursive struct error ([#4](https://github.com/athena-framework/console/pull/4)) (George Dietrich)
- **Breaking:** fix typo in parameter name of `ACON::Command#option` method ([#3](https://github.com/athena-framework/console/pull/3)) (George Dietrich)

## [0.1.0] - 2021-10-30

_Initial release._

[0.2.0]: https://github.com/athena-framework/console/releases/tag/v0.2.0
[0.1.1]: https://github.com/athena-framework/console/releases/tag/v0.1.1
[0.1.0]: https://github.com/athena-framework/console/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 @@
# Console

[![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/console.svg)](https://github.com/athena-framework/console/releases)

Expand All @@ -13,7 +14,7 @@ Allows for the creation of CLI based commands.
dependencies:
athena-console:
github: athena-framework/console
version: ~> 0.1.0
version: ~> 0.2.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-console

version: 0.1.1
version: 0.2.0

crystal: ~> 1.4

Expand Down
4 changes: 2 additions & 2 deletions src/athena-console.cr
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ alias ACON = Athena::Console
# dependencies:
# athena-console:
# github: athena-framework/console
# version: ~> 0.1.0
# version: ~> 0.2.0
# ```
#
# Then run `shards install`.
#
# From here you can then setup your entry point file talked about earlier, being sure to require the component via `require "athena-console"`.
# Finally, create/require your `ACON::Command`s, and customize the `ACON::Application` as needed.
module Athena::Console
VERSION = "0.1.1"
VERSION = "0.2.0"

# Includes the commands that come bundled with `Athena::Console`.
module Commands; end
Expand Down

0 comments on commit 1aeee53

Please sign in to comment.