Bump docs to 1.0.1 and add release docs step

Replace 1.0.1-SNAPSHOT with the released 1.0.1 across README.md and docs, and add a CI step to the release workflow that extracts the release version (stripping a leading 'v'), updates version references in the docs, commits, and pushes changes before creating the GitHub release. The workflow updates README.md and the getting-started/guides markdown files by replacing semver or semver-SNAPSHOT patterns with the released version.

Author: jcputney

.github/workflows/release.yml

@@ -47,6 +47,33 @@ jobs:
           OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
           MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
 
+      - name: Update docs with released version
+        run: |
+          VERSION=$(grep '^scm.tag=' release.properties | cut -d'=' -f2)
+          # Strip leading 'v' if present (e.g., v1.0.1 -> 1.0.1)
+          RELEASE_VERSION="${VERSION#v}"
+
+          FILES=(
+            README.md
+            docs/docs/getting-started/installation.md
+            docs/docs/guides/resolvers.md
+            docs/docs/guides/spring-boot.md
+          )
+          for f in "${FILES[@]}"; do
+            if [ -f "$f" ]; then
+              # Replace any semver or semver-SNAPSHOT with the released version
+              sed -i "s/[0-9]\+\.[0-9]\+\.[0-9]\+\(-SNAPSHOT\)\{0,1\}/${RELEASE_VERSION}/g" "$f"
+            fi
+          done
+
+          if git diff --quiet; then
+            echo "No doc version changes needed"
+          else
+            git add "${FILES[@]}"
+            git commit -m "docs: update version references to ${RELEASE_VERSION}"
+            git push
+          fi
+
       - name: Create GitHub Release
         run: |
           VERSION=$(grep '^scm.tag=' release.properties | cut -d'=' -f2)

README.md

@@ -40,14 +40,14 @@ Most users only need `mjml-java-core`. Add `mjml-java-resolvers` if you need URL
 <dependency>
     <groupId>dev.jcputney</groupId>
     <artifactId>mjml-java-core</artifactId>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>1.0.1</version>
 </dependency>
 ```
 
 ### Gradle
 
 ```groovy
-implementation 'dev.jcputney:mjml-java-core:1.0.1-SNAPSHOT'
+implementation 'dev.jcputney:mjml-java-core:1.0.1'
 ```
 
 ### Usage

docs/docs/getting-started/installation.md

@@ -28,7 +28,7 @@ Add the following dependency to your `pom.xml`:
 <dependency>
     <groupId>dev.jcputney</groupId>
     <artifactId>mjml-java-core</artifactId>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>1.0.1</version>
 </dependency>
 ```
 
@@ -37,13 +37,13 @@ Add the following dependency to your `pom.xml`:
 Add the following to your `build.gradle`:
 
 ```groovy
-implementation 'dev.jcputney:mjml-java-core:1.0.1-SNAPSHOT'
+implementation 'dev.jcputney:mjml-java-core:1.0.1'
 ```
 
 Or for Kotlin DSL (`build.gradle.kts`):
 
 ```kotlin
-implementation("dev.jcputney:mjml-java-core:1.0.1-SNAPSHOT")
+implementation("dev.jcputney:mjml-java-core:1.0.1")
 ```
 
 ## Using the BOM
@@ -58,7 +58,7 @@ To manage versions across multiple modules, import the BOM:
         <dependency>
             <groupId>dev.jcputney</groupId>
             <artifactId>mjml-java-bom</artifactId>
-            <version>1.0.1-SNAPSHOT</version>
+            <version>1.0.1</version>
             <type>pom</type>
             <scope>import</scope>
         </dependency>
@@ -81,7 +81,7 @@ To manage versions across multiple modules, import the BOM:
 
 ```groovy
 dependencies {
-    implementation platform('dev.jcputney:mjml-java-bom:1.0.1-SNAPSHOT')
+    implementation platform('dev.jcputney:mjml-java-bom:1.0.1')
     implementation 'dev.jcputney:mjml-java-core'
     implementation 'dev.jcputney:mjml-java-resolvers'
 }

docs/docs/guides/resolvers.md

@@ -51,7 +51,7 @@ Add the resolvers module to your project:
 <dependency>
     <groupId>dev.jcputney</groupId>
     <artifactId>mjml-java-resolvers</artifactId>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>1.0.1</version>
 </dependency>
 ```
 

docs/docs/guides/spring-boot.md

@@ -15,7 +15,7 @@ Add the Spring module to your project:
 <dependency>
     <groupId>dev.jcputney</groupId>
     <artifactId>mjml-java-spring</artifactId>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>1.0.1</version>
 </dependency>
 ```