Skip to content

Commit

Permalink
Merge branch 'hotfix/1.1.1' into github/main
Browse files Browse the repository at this point in the history
  • Loading branch information
drone committed Nov 1, 2024
2 parents a7968a2 + 0fc8e7d commit 205c4bd
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 22 deletions.
2 changes: 1 addition & 1 deletion BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To use the source code directly, follow these steps:
```
4. Run the application:
```sh
java -jar target/keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
java -jar target/keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
```

## Docker
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [v1.1.1] - 2024-11-01
### Changed
- Update Maven dependencies

## [v1.1.0] - 2024-10-21
### Added
- Auto-generated entries when using Conventional Commits
Expand All @@ -28,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Support for semantic versioning.

[unreleased]: https://github.com/kirbylink/java-keep-a-changelog-updater/compare/main...HEAD
[v1.1.1]: https://github.com/kirbylink/java-keep-a-changelog-updater/compare/v1.1.0...v1.1.1
[v1.1.0]: https://github.com/kirbylink/java-keep-a-changelog-updater/compare/v1.0.1...v1.1.0
[v1.0.1]: https://github.com/kirbylink/java-keep-a-changelog-updater/compare/v1.0.0...v1.0.1
[v1.0.0]: https://github.com/kirbylink/java-keep-a-changelog-updater/releases/tag/v1.0.0
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,17 +186,17 @@ See [BUILD.md](./BUILD.md) how to build from Source Code
### Using the Compiled JAR
To use the compiled JAR file, follow these steps:

1. Download the latest release (`keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar`) from the [Releases page](https://github.com/kirbylink/java-keep-a-changelog-updater/releases).
1. Download the latest release (`keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar`) from the [Releases page](https://github.com/kirbylink/java-keep-a-changelog-updater/releases).
2. Run the JAR file:
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
```

### Command-Line Parameters
You can start the program with optional parameters. To get all parameters, start the program with `-h` or `--help`:
```bash
usage: java -jar
keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
-h | -s <arg>
-h,--help Print this help message
-s,--scenario <arg> Scenario to execute: create, add-entry, release,
Expand All @@ -206,7 +206,7 @@ usage: java -jar
With `-s` or `--scenario` and `create|add-entry|release` you get all parameters that is needed for the scenario:
```bash
usage: java -jar
keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
-s create -b <arg> -c | -o <arg> [-d <arg>] -r <arg> [-t <arg>]
-b,--branch <arg> Main branch for link generation
-c,--console Output result to console instead of a file
Expand All @@ -219,7 +219,7 @@ usage: java -jar

```bash
usage: java -jar
keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
-s add-entry -c | -o <arg> -d <arg> -i <arg> -t <arg> [-v <arg>]
-c,--console Output result to console instead of a file
-d,--description <arg> Description for a new entry
Expand All @@ -232,7 +232,7 @@ usage: java -jar

```bash
usage: java -jar
keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
-s release -b <arg> -c | -o <arg> -i <arg> -r <arg> -rt <arg>
-b,--branch <arg> Main branch for link generation
-c,--console Output result to console instead of a file
Expand All @@ -244,7 +244,7 @@ usage: java -jar

```bash
usage: java -jar
keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar
keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar
-s auto-generate [-a] [-b <arg>] -c | -o <arg> -g <arg> -i <arg>
[-p <arg>] [-r <arg>] [-v <arg>]
-a,--auto-release Create automatically a Release after log
Expand All @@ -268,7 +268,7 @@ Here are some examples of how to use the Java Keep-A-Changelog Updater:
### Example 1: Create empty Changelog
Creates an empty CHANGELOG.md file under /path/to/output/folder/CHANGELOG.md. Using repository URL and branch to link unreleased commitments.
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s create -o /path/to/output/folder/CHANGELOG.md -b main -r https://example.com/example-project.git
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s create -o /path/to/output/folder/CHANGELOG.md -b main -r https://example.com/example-project.git
```
Example outcome:
Expand All @@ -288,7 +288,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Example 2a: Add an entry to Unreleased version
Reads a CHANGELOG.md file as input, writes under `Unreleased` in category `Changed` the entry `Update Maven dependencies` and save it in the same file.
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s add-entry -i /path/to/CHANGELOG.md -d 'Update Maven dependencies' -t Changed -o
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s add-entry -i /path/to/CHANGELOG.md -d 'Update Maven dependencies' -t Changed -o
```
Example outcome:
Expand All @@ -310,7 +310,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Example 2b: Add an entry to existing or new version
Reads a CHANGELOG.md file as input, writes under `1.0.0` in category `Added` the entry `Some amazing features` and save it in the same file.
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s add-entry -i /path/to/CHANGELOG.md -d 'Some amazing features' -t Added -v 1.0.0 -o
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s add-entry -i /path/to/CHANGELOG.md -d 'Some amazing features' -t Added -v 1.0.0 -o
```
Example outcome:
Expand All @@ -337,7 +337,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Example 3: Create a Release version
Reads a CHANGELOG.md file as input and creates a new Release version with increased Patch version. Using repository URL and branch to create links for all versions.
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s release -i /path/to/CHANGELOG.md -b main -r https://example.com/example-project.git -rt patch -o
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s release -i /path/to/CHANGELOG.md -b main -r https://example.com/example-project.git -rt patch -o
```
Example outcome:
Expand Down Expand Up @@ -386,7 +386,7 @@ Date: Thu Oct 3 13:42:47 2024 +0200
```
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s auto-generate -i /path/to/CHANGELOG.md -g /path/to/git-log.txt -c
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s auto-generate -i /path/to/CHANGELOG.md -g /path/to/git-log.txt -c
```
Example outcome:
```markdown
Expand Down Expand Up @@ -451,7 +451,7 @@ Date: Thu Oct 3 13:43:47 2024 +0200
```
```sh
java -jar keep-a-changelog-updater-1.1.0-jar-with-dependencies.jar -s auto-generate -i /path/to/CHANGELOG.md -g /path/to/git-log.txt -a -b main -r https://example.com/example-project.git -c
java -jar keep-a-changelog-updater-1.1.1-jar-with-dependencies.jar -s auto-generate -i /path/to/CHANGELOG.md -g /path/to/git-log.txt -a -b main -r https://example.com/example-project.git -c
```
Example outcome:
```markdown
Expand Down
2 changes: 1 addition & 1 deletion VERSION.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.0
1.1.1
14 changes: 7 additions & 7 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<name>Java Keep a Changelog Updater</name>
<description>This project is a Java application designed to parse and update
"keep a changelog" CHANGELOG.md files</description>
<version>1.1.0</version>
<version>1.1.1</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
Expand All @@ -20,19 +20,19 @@
<commons-cli.version>1.9.0</commons-cli.version>
<lombok.version>1.18.34</lombok.version>
<slf4j-api.version>2.0.16</slf4j-api.version>
<logback-classic.version>1.5.11</logback-classic.version>
<logback-classic.version>1.5.12</logback-classic.version>
<flexmark.version>0.64.8</flexmark.version>
<jackson-core.version>2.18.0</jackson-core.version>
<jackson-databind.version>2.18.0</jackson-databind.version>
<jackson-dataformat-yaml.version>2.18.0</jackson-dataformat-yaml.version>
<jackson-core.version>2.18.1</jackson-core.version>
<jackson-databind.version>2.18.1</jackson-databind.version>
<jackson-dataformat-yaml.version>2.18.1</jackson-dataformat-yaml.version>
<mockito-core.version>5.14.2</mockito-core.version>
<mockito-junit-jupiter.version>5.14.2</mockito-junit-jupiter.version>
<junit-jupiter.version>5.11.2</junit-jupiter.version>
<junit-jupiter.version>5.11.3</junit-jupiter.version>
<assertj-core.version>3.26.3</assertj-core.version>
<maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
<maven-surefire-plugin.version>3.5.1</maven-surefire-plugin.version>
<maven-failsafe-plugin.version>3.5.1</maven-failsafe-plugin.version>
<maven-dependency-plugin.version>3.8.0</maven-dependency-plugin.version>
<maven-dependency-plugin.version>3.8.1</maven-dependency-plugin.version>
<gitflow-maven-plugin.version>1.21.0</gitflow-maven-plugin.version>
<properties-maven-plugin.version>1.2.1</properties-maven-plugin.version>
</properties>
Expand Down

0 comments on commit 205c4bd

Please sign in to comment.