docs: prepare for re-creating release 0.1.0

Author: simschla

CHANGELOG.md

@@ -10,11 +10,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - Support for transporting changelog to github releases
-
-## [0.1.0] - 2025-04-25
-
-### Fixed
-
 - Make sure release binaries are executable on unix systems
 - Make sure to use same zips for chocolatey distribution that are used for the release
 

README.md

@@ -12,7 +12,7 @@ output = [
   ].join('\n')
 -->
 
-[![SpotlessCLI Version](https://img.shields.io/badge/latest--version-0.1.0-blue.svg)](CHANGES.md)
+[![SpotlessCLI Version](https://img.shields.io/badge/latest--version-0.0.0-blue.svg)](CHANGES.md)
 
 [![OS Win](https://img.shields.io/badge/OS-Windows-blueviolet.svg)](#installation-on-windows)
 [![OS Linux](https://img.shields.io/badge/OS-Linux-blueviolet.svg)](#installation-on-macos-and-linux)

build-logic/src/main/groovy/buildlogic.spotless-markdown-conventions.gradle

@@ -1,6 +1,5 @@
 import com.diffplug.spotless.cli.picocli.usage.DocumentedUsages
 import com.diffplug.gradle.spotless.FreshMarkExtension
-import com.oracle.svm.core.annotate.Inject
 
 plugins {
 	id 'buildlogic.spotless-common-conventions'
@@ -10,7 +9,7 @@ plugins {
 Action<FreshMarkExtension> freshmarkSetup = new Action<FreshMarkExtension>(){
 
 			void execute(FreshMarkExtension freshmark) {
-				freshmark.target '*.md'
+				freshmark.target '*.md', 'docs/devs/*.md'
 				freshmark.properties(new FreshmarkPropertiesAction(rootProject, project))
 				freshmark.properties {
 					it.put('changeThisValueToForceCacheMiss', '1f31705c-b1c6-4bce-9831-98881431b721')
@@ -76,7 +75,7 @@ class FreshmarkPropertiesAction implements Action<Map<String, Object>> {
 		properties.putAll(versionsCollected)
 		def usageHelps = getUsageHelps()
 		properties.putAll(usageHelps)
-		properties.put('spotlessVersion', rootProject.spotlessChangelog.versionLast)
+		properties.put('spotlessVersion', rootProject.spotlessChangelog.versionLast ?: '0.0.0')
 	}
 
 	Map<String, String> getVersionsCollected() {

docs/devs/RELEASING.md

@@ -0,0 +1,52 @@
+# Developer Notes for Releasing
+
+## Creating a release
+
+To create a new release, follow these steps (everything automated):
+
+1. Navigate to https://github.com/diffplug/spotless-cli/actions/workflows/publish.yml
+2. Click on "Run workflow", use main branch, by default don't provide a version number
+
+## Re-creating a release
+
+If for some reason, we need to re-create a release, follow these steps (manual labor involved):
+
+### In spotless-cli repo:
+
+https://github.com/diffplug/spotless-cli
+
+1. Navigate to "Releases" (right column)
+2. Make sure you are on the right release version (the one you need to recreate)
+3. Click on the trashcan in the upper right corner of the release
+4. Confirm
+5. Switch to "Tags" in the tab-bar at the top
+6. Click on the `...` at the very right of the version to recreate -> Delete tag
+7. Confirm
+
+### In homebrew-tap repo:
+
+https://github.com/diffplug/homebrew-tap
+
+1. Navigate to "Releases" (right column)
+2. Switch to "Tags" in the tab-bar at the top
+3. Click on the `...` at the very right of the version to recreate -> Delete tag
+4. Confirm
+
+### In chocolatey-bucket repo:
+
+https://github.com/diffplug/chocolatey-bucket
+
+1. Navigate to "Releases" (right column)
+2. Switch to "Tags" in the tab-bar at the top
+3. Click on the `...` at the very right of the version to recreate -> Delete tag
+4. Confirm
+
+### In local clone of spotless-cli repo:
+
+1. Make sure you are on main branch, pull the HEAD
+2. Open `CHANGELOG.md` and merge the version to recreate with the Unreleased version
+   This typically means deleting the release header and empty lines, but could mean to cut&paste sections together
+3. Run `gradlew changelogCheck -i` to make sure the changelog is valid
+4. If you have the deleted tag also locally, delete it with `git tag -d <tagname>` e.g. `git tag -d v1.0.0`
+5. commit the changes with `git commit -m "changelog: recreate v<your-version>"` e.g. `git commit -m "changelog: recreate v1.0.0"`
+6. push the changes with `git push origin main`

jreleaser.yml.template

@@ -51,5 +51,6 @@ distributions:
     chocolatey:
       templateDirectory: app/src/jreleaser/distributions/spotless-cli/chocolatey
       username: @Env.JRELEASER_CHOCOLATEY_USER@ # does not support name templates, so use gradle templating
+      iconUrl: https://cdn.statically.io/gh/diffplug/spotless-cli/v{{projectVersion}}/docs/logo/spotless-brush-256.png
       repository:
         branch: main