diff --git a/.github/release-please-config.json b/.github/release-please-config.json index 7a8afee..5d91e02 100644 --- a/.github/release-please-config.json +++ b/.github/release-please-config.json @@ -8,5 +8,8 @@ }, "plugins": [ "sentence-case" + ], + "extra-files": [ + "README.md" ] } diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 1d1d0a8..afd7095 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -65,7 +65,11 @@ Building and deploying the actual Maven Artifacts for a release is the responsib After a release has been made, Release Please will automatically create another pull request to update the version numbers in `pom.xml` files to the next snapshot version (see the [Maven strategy](https://github.com/googleapis/release-please/blob/main/docs/java.md)). -This snapshot “release pull request” has to be merged immediately. +Version numbers in README.md will also get updated with snapshot versions although that is unwanted. Release Please +cannot be configured to skip updating README.md when creating a snapshot release. The unwanted changes need to be +reverted manually. +This snapshot “release pull request” has to be merged immediately after unwanted changes to version numbers in README.md +have been reverted. [Conventional Commits]: https://www.conventionalcommits.org/ diff --git a/README.md b/README.md index 19525fd..c67730e 100644 --- a/README.md +++ b/README.md @@ -13,22 +13,24 @@ The [hamcrest-mail][] sister project provides a set of Hamcrest matchers with si To use AssertJ Mail in a Maven project add a dependency on `org.devopsix:assertj-mail` (for Java EE 8 / javax.mail) or `org.devopsix:assertj-mail-jakarta` (for Jakarta EE 9+ / jakarta.mail) to the pom.xml file. + ```xml org.devopsix assertj-mail - 1.0.9 + 1.0.11 test org.devopsix assertj-mail-jakarta - 1.0.9 + 1.0.11 test ``` + The assertions are available as static methods on the `MailAssertions` class.