Skip to content

Commit 8eda5a2

Browse files
committed
[readme] add note about updating Spring Boot compatibility in README to release section
1 parent 8ca29e9 commit 8eda5a2

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -382,20 +382,22 @@ Pull requests are welcome. For major changes, please open an issue first to disc
382382

383383
Please make sure to update tests as appropriate.
384384

385-
## License
386-
387-
[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)
388-
389385
## Release
390386

391387
To release a new version of the project, follow these steps:
392388

393-
1. Update `pom.xml` with the new version (Use `mvn versions:set -DgenerateBackupPoms=false -DnewVersion=<VERSION>`)
394-
2. Commit the changes locally.
395-
3. Tag the commit with the version (e.g. `1.0.0`) and push the tag.
396-
4. Create a new release in GitHub via https://github.com/wimdeblauwe/htmx-spring-boot/releases/new
389+
1. Update the `pom.xml` with the new release version.\
390+
`mvn versions:set -DgenerateBackupPoms=false -DnewVersion=<VERSION>`
391+
2. Update Spring Boot compatibility in the `README.md`.
392+
3. Commit the changes locally with the following commit message: `Release <VERSION>`.
393+
4. Create a tag for the commit with the version (e.g. `1.0.0`) and push the tag.
394+
5. Create a [new release](https://github.com/wimdeblauwe/htmx-spring-boot/releases/new) in GitHub.
397395
- Select the newly pushed tag
398-
- Update the release notes. This should automatically start
399-
the [release action](https://github.com/wimdeblauwe/htmx-spring-boot-thymeleaf/actions).
400-
5. Update `pom.xml` again with the next `SNAPSHOT` version.
401-
6. Close the milestone in the GitHub issue tracker.
396+
- Update the release notes.
397+
- This should automatically start the [release action](https://github.com/wimdeblauwe/htmx-spring-boot/actions).
398+
6. Update `pom.xml` again with the next `SNAPSHOT` version.
399+
7. Close the [milestone](https://github.com/wimdeblauwe/htmx-spring-boot/milestones) in GitHub.
400+
401+
## License
402+
403+
[Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)

0 commit comments

Comments
 (0)