Skip to content

Commit 9bd1db9

Browse files
committed
Add automatic README version updates to release workflow
- Update README.md version during release process - Include README.md in release commit - Ensures documentation stays in sync with releases
1 parent 6b26f59 commit 9bd1db9

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

.github/workflows/release.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,17 @@ jobs:
8282
sed -i "s/<dynamodb-toolkit.version>.*<\/dynamodb-toolkit.version>/<dynamodb-toolkit.version>$NEW_VERSION<\/dynamodb-toolkit.version>/" pom.xml
8383
sed -i "s/<dynamodb-toolkit.version>.*<\/dynamodb-toolkit.version>/<dynamodb-toolkit.version>$NEW_VERSION<\/dynamodb-toolkit.version>/" integration-tests/pom.xml
8484
85+
# Update version in README.md
86+
sed -i "s/<version>v[^<]*<\/version>/<version>v$NEW_VERSION<\/version>/" README.md
87+
8588
- name: Build and verify
8689
run: |
8790
mvn clean install
8891
cd integration-tests && mvn clean compile
8992
9093
- name: Commit and tag release
9194
run: |
92-
git add pom.xml integration-tests/pom.xml
95+
git add pom.xml integration-tests/pom.xml README.md
9396
git commit -m "Release version $NEW_VERSION"
9497
git tag -a "v$NEW_VERSION" -m "Release version $NEW_VERSION"
9598

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,25 @@ public class DynamoDbRoutesRepository implements RoutesRepository {
9696

9797
## Build Integration
9898

99-
Add the annotation processor to your Maven build:
99+
Add the JitPack repository and dependency to your Maven build:
100100

101101
```xml
102+
<repositories>
103+
<repository>
104+
<id>jitpack.io</id>
105+
<url>https://jitpack.io</url>
106+
</repository>
107+
</repositories>
108+
102109
<dependency>
103-
<groupId>io.github.wassertim</groupId>
110+
<groupId>com.github.wassertim</groupId>
104111
<artifactId>dynamodb-toolkit</artifactId>
105-
<version>1.0.0-SNAPSHOT</version>
112+
<version>v1.0.20</version>
106113
</dependency>
107114
```
108115

116+
See [JitPack releases](https://jitpack.io/#wassertim/dynamodb-toolkit) for the latest version.
117+
109118
The annotation processor runs automatically during compilation and generates mapper classes in the same package as your domain classes.
110119

111120
## Benefits over Manual Mapping

0 commit comments

Comments
 (0)