Skip to content

Commit

Permalink
Prepare documentation for version 2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
JohT committed Aug 31, 2022
1 parent a28724a commit 6f2a156
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Changelog for [alias](https://github.com/JohT/alias).
- [#81](https://github.com/JohT/alias/pull/81) Support Java 11, base library remains Java 1.8 (2022-07-26)
- [#82](https://github.com/JohT/alias/pull/82) Configure renovate version updates for arquillian.xml (2022-07-26)
- [#86](https://github.com/JohT/alias/pull/86) Provide version number independent wildfly distribution folder (2022-07-27)
- [#94](https://github.com/JohT/alias/pull/94) Generate CHANGELOG.md automatically (2022-08-31)

### Dependencies
- [#31](https://github.com/JohT/alias/pull/31) Update dependency org.eclipse:yasson to v2 (2021-10-26)
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ that generates (by default) the ResourceBundle `TypeAlias.java` inside the defau
<dependency>
<groupId>io.github.joht.alias</groupId>
<artifactId>type-alias</artifactId>
<version>1.1.2</version>
<version>2.0.0</version>
<scope>provided</scope>
<optional>true</optional>
</dependency>
Expand All @@ -36,6 +36,15 @@ that generates (by default) the ResourceBundle `TypeAlias.java` inside the defau
### Building this project
Install maven and use `mvn install` to build this project, run all tests including the integration tests and copy the resulting artifacts into the local maven repository. A list of the most important commands can be found in [COMMANDS.md](COMMANDS.md).

### Changes
All changes are listed in [CHANGELOG.md](./CHANGELOG.md). The file is generated automatically during "generate-resources" build phase based on merged pull requests and their tags.

#### Breaking changes in Version 2.x

- `type-alias-jsonb-typereference` had been migrated to Java 11
- `type-alias-example` had been migrated to Java 11
- `type-alias-axon-serializer-integration-test` will no longer be published to maven central

### Contents
- [type-alias](https://github.com/JohT/alias/tree/master/type-alias)
contains the main module with the java annotation processing based file generator.
Expand Down

0 comments on commit 6f2a156

Please sign in to comment.