chore: add spotless-changelog + introduce changelog

simschla · simschla · commit 10875ea8dbe7 · 2025-03-03T23:30:26.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial version of the CLI
diff --git a/build-logic/src/main/groovy/buildlogic.changelog-conventions.gradle b/build-logic/src/main/groovy/buildlogic.changelog-conventions.gradle
@@ -0,0 +1,3 @@
+plugins {
+    id 'com.diffplug.spotless-changelog'
+}
diff --git a/build.gradle b/build.gradle
@@ -1,6 +1,7 @@
 plugins {
 	id 'buildlogic.spotless-gradle-conventions'
 	id 'buildlogic.spotless-markdown-conventions'
+	id 'buildlogic.changelog-conventions'
 }
 
 subprojects {
diff --git a/settings.gradle b/settings.gradle
@@ -22,6 +22,9 @@ plugins {
 
 	// https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md
 	id 'com.diffplug.spotless' version '7.0.2' apply false
+
+	// https://github.com/diffplug/spotless-changelog/blob/main/README.md
+	id 'com.diffplug.spotless-changelog' version '3.1.2' apply false
 }
 
 rootProject.name = 'spotless-cli'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+plugins {`
	`2`	`+ id 'com.diffplug.spotless-changelog'`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`plugins {`
`2`	`2`	`id 'buildlogic.spotless-gradle-conventions'`
`3`	`3`	`id 'buildlogic.spotless-markdown-conventions'`
	`4`	`+ id 'buildlogic.changelog-conventions'`
`4`	`5`	`}`
`5`	`6`
`6`	`7`	`subprojects {`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ plugins {`
`22`	`22`
`23`	`23`	`// https://github.com/diffplug/spotless/blob/main/plugin-gradle/CHANGES.md`
`24`	`24`	`id 'com.diffplug.spotless' version '7.0.2' apply false`
	`25`	`+`
	`26`	`+ // https://github.com/diffplug/spotless-changelog/blob/main/README.md`
	`27`	`+ id 'com.diffplug.spotless-changelog' version '3.1.2' apply false`
`25`	`28`	`}`
`26`	`29`
`27`	`30`	`rootProject.name = 'spotless-cli'`