Enable checking git diffs for modifying "frozen" areas

.github/workflows/java8-maven.yml → .github/workflows/java-maven.yml

@@ -1,4 +1,4 @@
-name: Java8+ with Maven
+name: Java LTS with Maven
 
 on: [ push, pull_request ]
 
@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java: [ 8, 17 ]
+        java: [ 17 ]
         os: [ ubuntu-latest, macOS-latest, windows-latest ]
 
     name: JDK${{ matrix.java }} on ${{ matrix.os }}
@@ -58,7 +58,7 @@ jobs:
     if: startsWith(github.repository, 'nbbrd/') && startsWith(github.ref, 'refs/heads/develop')
     strategy:
       matrix:
-        java: [ 17 ]
+        java: [ 11, 17 ]
         os: [ ubuntu-latest ]
 
     name: Snapshot on develop

CHANGELOG.md

@@ -7,9 +7,14 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+- Add support for checking git diffs for touching released versions. Use `-g` at the command line.
+
 ### Changed
 
 - Output all separators in error message by [@koppor](https://github.com/koppor) [#164](https://github.com/nbbrd/heylogs/pull/164)
+- Minimum Java requirement is now Java 11 (due to the dependency on [Eclipse JGit](https://eclipse.dev/jgit/))
 
 ### Fixed
 

README.md

@@ -9,19 +9,26 @@ It can be used as a linter in interactive sessions and automations.
 Key points:
 
 - Available as a library, a [command-line tool](#installation) and a [Maven plugin](#maven-plugin)
-- Java 8 minimum requirement
+- Java 11 minimum requirement
 
 Features:
 
 - Summarizes content
 - Checks format
 - Extracts versions
 
+The `check` feature also contains a check if during an update of the CHANGELOG.md file, areas of released versions are touched.
+For instance, a contributor starts a pull request and adds their change to CHANGELOG.md.
+Then, the main branch is released.
+Now, the PR should move the changelog entry to the new `[unreleased]` section.
+Therefore, `heylogs` warns in case there are modifications inside blocks of released versions.
+One has to enable this check explicitly by the `-g` command line parameter.
+
 ## Command-line tool
 
 Heylogs CLI runs on any desktop operating system such as Microsoft Windows, 
 Solaris OS, Apple macOS, Ubuntu and other various Linux distributions. 
-It requires a Java SE Runtime Environment (JRE) version 8 or later to run on such as OpenJDK.
+It requires a Java SE Runtime Environment (JRE) version 11 or later to run on such as OpenJDK.
 
 ### Installation
 
@@ -149,7 +156,7 @@ The following script extracts the latest version from the changelog during a rel
 ## Developing
 
 This project is written in Java and uses [Apache Maven](https://maven.apache.org/) as a build tool.  
-It requires [Java 8 as minimum version](https://whichjdk.com/) and all its dependencies are hosted
+It requires [Java 11 as minimum version](https://whichjdk.com/) and all its dependencies are hosted
 on [Maven Central](https://search.maven.org/).
 
 The code can be build using any IDE or by just type-in the following commands in a terminal:

heylogs-api/pom.xml

@@ -69,6 +69,32 @@
             <artifactId>java-io-base</artifactId>
             <version>0.0.26</version>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.jgit</groupId>
+            <artifactId>org.eclipse.jgit</artifactId>
+            <version>6.7.0.202309050840-r</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-api</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>org.jooq</groupId>
+            <artifactId>jool</artifactId>
+            <version>0.9.15</version>
+        </dependency>
+        <dependency>
+            <groupId>org.tinylog</groupId>
+            <artifactId>tinylog-api</artifactId>
+        </dependency>
+        <!-- required for jgit -->
+        <dependency>
+            <groupId>org.tinylog</groupId>
+            <artifactId>slf4j-tinylog</artifactId>
+            <version>2.6.2</version>
+        </dependency>
 
         <!-- test only -->
         <dependency>
@@ -81,5 +107,11 @@
             <artifactId>assertj-core</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.tinylog</groupId>
+            <artifactId>tinylog-impl</artifactId>
+            <version>${tinylog.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>