#342: Restructure changelog

README.md

@@ -33,7 +33,7 @@ Sonarcloud status:
 
 * [Blog](https://blog.itsallcode.org/)
 * [User Guide](doc/user_guide.md)
-* [Changelog](doc/CHANGELOG.md)
+* [Changelog](doc/changes/changes.md)
 * [OpenFastTrace stories](https://github.com/itsallcode/openfasttrace/wiki/OFT-Stories)
 * [Developer Guide](doc/developer_guide.md)
 * [Contributing guide](CONTRIBUTING.md)

doc/changes/changes.md

@@ -0,0 +1,39 @@
+# Changes
+
+* [3.7.0](changes_3.7.0.md)
+* [3.6.0](changes_3.6.0.md)
+* [3.5.0](changes_3.5.0.md)
+* [3.4.0](changes_3.4.0.md)
+* [3.3.0](changes_3.3.0.md)
+* [3.2.1](changes_3.2.1.md)
+* [3.2.0](changes_3.2.0.md)
+* [3.1.0](changes_3.1.0.md)
+* [3.0.2](changes_3.0.2.md)
+* [3.0.2](changes_3.0.2.md)
+* [3.0.1](changes_3.0.1.md)
+* [3.0.0](changes_3.0.0.md)
+* [2.3.5](changes_2.3.5.md)
+* [2.3.4](changes_2.3.4.md)
+* [2.3.3](changes_2.3.3.md)
+* [2.3.2](changes_2.3.2.md)
+* [2.3.1](changes_2.3.1.md)
+* [2.3.0](changes_2.3.0.md)
+* 2.2.0
+* 2.1.0
+* 2.0.2
+* 2.0.1
+* 2.0.0
+* 1.2.1
+* 1.2.0
+* 1.1.0
+* 1.0.0
+* 0.6.0
+* 0.5.4
+* 0.5.3
+* 0.5.2
+* 0.5.1
+* 0.5.0
+* 0.4.0
+* 0.3.0
+* 0.2.0
+* 0.1.0

doc/changes/changes_2.3.0.md

@@ -0,0 +1,3 @@
+# OpenFastTrace 2.3.0, released 2019-03-31
+
+Code name: Unreleased (skipped on GitHub)

doc/changes/changes_2.3.1.md

@@ -0,0 +1,3 @@
+# OpenFastTrace 2.3.1, released 2019-03-31
+
+Code name: Unreleased (skipped on GitHub)

doc/changes/changes_2.3.2.md

@@ -0,0 +1,3 @@
+# OpenFastTrace 2.3.2, released 2019-04-05
+
+Code name: Unreleased (skipped on GitHub)

doc/changes/changes_2.3.3.md

@@ -0,0 +1,3 @@
+# OpenFastTrace 2.3.3, released 2019-04-14
+
+Code name: Unreleased (skipped on GitHub)

doc/changes/changes_2.3.4.md

@@ -0,0 +1,3 @@
+# OpenFastTrace 2.3.4, released 2019-04-14
+
+Code name: Unreleased (skipped on GitHub)

doc/changes/changes_2.3.5.md

@@ -0,0 +1,23 @@
+# OpenFastTrace 2.3.0, released 2019-04-14
+
+Code name: New project structure
+
+## Summary
+
+In this release we split OFT into Maven submodules.
+
+## Features
+
+* #226: Pretty print specobjects
+
+## Bugfixes
+
+* #231: Fixed maven project deployment
+* #209: Export specobject title
+* #215: Fix exit codes
+
+## Refactoring
+
+* #213: New project structure with submodules
+* #221: Extracted reporters into submodule
+* #224: Simplified Maven setup

doc/changes/changes_3.0.0.md

@@ -0,0 +1,17 @@
+# OpenFastTrace 3.0.0, released 2019-04-21
+
+Code name: Broader Tag Importer Support
+
+## Summary
+
+In this release we ported OFT to Java 11 which is a breaking change.
+
+We also broadened the support of file types in the `TagImporter`.
+
+## Features
+
+* #238: Added more file suffixes to the `TagImporter`
+
+## Refactoring
+
+* #238: Ported to Java 11

doc/changes/changes_3.0.1.md

@@ -0,0 +1,7 @@
+# OpenFastTrace 3.0.1 
+
+Code name: Unreleased on GitHub
+
+## Bugfixes
+
+* Published pom files contained invalid version: `<version>${revision}</version>`

doc/changes/changes_3.0.2.md

@@ -0,0 +1,7 @@
+# OpenFastTrace 3.0.2
+
+Code name: Unreleased on GitHub
+
+## Bugfixes
+
+* Fix deployment to maven central: attributes in pom.xml where missing.

doc/changes/changes_3.1.0.md

@@ -0,0 +1,11 @@
+# OpenFastTrace 3.1.0, released 2021-05-20
+
+Code name: Support for Clojure, Kotlin and Scala in `TagImporter`
+
+## Summary
+
+In this release we added support for Clojure, Kotlin and Scala in `TagImporter` by adding the respective file suffixes to the importer.
+
+## Features
+
+* #270: Support for Clojure, Kotlin and Scala in `TagImporter` 

doc/changes/changes_3.2.0.md

@@ -0,0 +1,13 @@
+# OpenFastTrace 3.2.0, released 2021-05-30
+
+Code name: ASPEC exporter
+
+## Summary
+
+ASPEC ("Augmented Spec Objects") is a data exchange format that extends the Spec Object Format with results from a requirement tracing run.
+
+In this release we added an exporter that creates ASPEC documents.
+
+## Features
+
+* #260: Added ASPEC exporter

doc/changes/changes_3.2.1.md

@@ -0,0 +1,24 @@
+# OpenFastTrace 3.2.1, released 2021-07-19
+
+Code name: Dependency updates on top of 3.2.0
+
+## Summary
+
+In this release we updated dependencies.
+
+## Dependencies Updates
+
+### Compile Dependency Updates
+
+- [license-maven-plugin](https://github.com/itsallcode/openfasttrace/pull/276)
+- [flatten-maven-plugin](https://github.com/itsallcode/openfasttrace/pull/278)
+- [maven-javadoc-plugin](https://github.com/itsallcode/openfasttrace/pull/279)
+- [plantuml](https://github.com/itsallcode/openfasttrace/pull/81)
+- [pitest-maven](https://github.com/itsallcode/openfasttrace/pull/282)
+- [maven-deploy-plugin](https://github.com/itsallcode/openfasttrace/pull/283)
+
+### Test Dependency Updates
+
+- [JUnit](https://github.com/itsallcode/openfasttrace/pull/275)
+- [mockito-junit-jupiter](https://github.com/itsallcode/openfasttrace/pull/284)
+- [equalsverifier](https://github.com/itsallcode/openfasttrace/pull/285)

doc/changes/changes_3.3.0.md

@@ -0,0 +1,16 @@
+# OpenFastTrace 3.3.0, released 2021-11-12
+
+Code name: Go and PlantUML support in the `TagImporter`
+
+## Summary
+
+In this release we added support for building with Java 16 and added the file suffixed for Go and PlantUML to the `TagImporter`.
+
+## Features
+
+* #294: Go support
+* #296: PlantUML support
+
+## Refactoring
+
++ #287: Support building, testing and running with Java 16

doc/changes/changes_3.4.0.md

@@ -0,0 +1,11 @@
+# OpenFastTrace 3.4.0, released 2022-01-31
+
+Code name: Required coverage in `TagImporter`
+
+## Summary
+
+With this release you can now optionally require coverage in the `TagImporter`.
+
+## Features
+
+* #306: Optionally require coverage in `TagImporter`

doc/changes/changes_3.5.0.md

@@ -0,0 +1,22 @@
+# OpenFastTrace 3.0.5, released 2022-03-17
+
+Code name: Help command
+
+## Summary
+
+You can now get a short help text by issuing the following:
+
+```shell
+oft help
+```
+
+Also, the `TagImporter` now generates names that are more readable when requirement coverage is requested.
+
+## Features
+
+* #315: Readable name for imported tags with needed coverage
+* #317: `help` command
+
+## Documentation
+
+* #305: Added info about `ReportSettings` and `ReportToPath` to user guide

doc/changes/changes_3.6.0.md

@@ -0,0 +1,22 @@
+# OpenFastTrace 3.6.0, released 
+
+Code name: C# and Robot Framework support in `TagImporter`
+
+## Summary
+
+In this release we added support for C# (`.cs`) and Robot Framework files (`.robot`) in the `TagImporter`.
+
+We now also upload a self-tracing report as part of the CI build and added support for Java 9 modules by outfitting all submodules with `module-info.java` files.
+
+## Features
+
+* #302: Added support for Robot Framework with postfix `.robot`
+* #326: Added support for C# files with postfix `.cs`
+
+## Refactoring
+
+* #246: Upload self-tracing report to GitHub Action result in CI build
+* #329: Fixed static code analysis warnings in unit tests
+* #330: upgraded test and build dependencies
+* #334: Added `module-info.java` files to support Java modules
+* #331: Removed license headers from sources and `license-maven-plugin`

doc/changes/changes_3.7.0.md

@@ -0,0 +1,30 @@
+# OpenFastTrace 3.7.0, released 2023-01-04
+
+Code name: Improved console report and Typescript support
+
+## Summary
+
+In this release we added support for JavaScript (`js.`) and TypeScript files (`.ts`) to the `TagImporter`.
+
+The plain text report (aka "console report") got an overhaul to improve readability. We added optional color and font formatting output.
+We also reworked how the tracing results are presented in order to make the report more intuitive.
+
+The new change log now has one file per version to make maintaining and reading it easier.
+
+## Features
+
+* #338: Improve console report 
+
+## Bugfixes
+
+* #308: Fixed running unit tests under macOS, Jacoco code coverage and integration tests
+* #344: Added JavaScript (`js.`) and TypeScript files (`.ts`) to the `TagImporter`
+
+## Refactoring
+
+* #299: Added XML namespace support to SpecObject importer
+* #336: Added `provides`  tags to `module-info.java` files required by the service loader
+* #340: Added builds for macOS and Windows
+* #341: Renamed `develop` branch to `main` and deleted `master`
+* #342: Switched change log format to [Project Keeper](https://github.com/exasol/project-keeper) standard
+* #344: Added support for Java 18