diff --git a/third_party/docfx-doclet-143274/README.md b/third_party/docfx-doclet-143274/README.md index f1c9131a..4e16434a 100644 --- a/third_party/docfx-doclet-143274/README.md +++ b/third_party/docfx-doclet-143274/README.md @@ -31,16 +31,18 @@ mvn fmt:format To cut a new release of the doclet for updated Cloud RAD content, do the following steps: -1) Manually update the [version of the doclet in the pom.xml](https://github.com/googleapis/java-docfx-doclet/blob/main/third_party/docfx-doclet-143274/pom.xml#L9) to the next minor or patch version. -2) Commit that version update to the `main` branch, and then add a git tag to that version (minus the `-SNAPSHOT`). You can use the below commands as a template: +1) Manually update the [version of the doclet in the pom.xml](https://github.com/googleapis/java-docfx-doclet/blob/main/third_party/docfx-doclet-143274/pom.xml#L9) to the next minor or patch version with the "-SNAPSHOT" postfix. +e.g. Update `1.17.0-SNAPSHOT` to `1.18.0-SNAPSHOT` +2) Commit and merge the pom.xml update to the `main` branch. +3) Add a git tag to that commit (minus the `-SNAPSHOT` of the previous version). You can use the below commands as a template: -` git tag -a v1.. -m ""` +`git tag -a v1.. -m "chore: release v1.."` `git push origin v1..` 3) Update the `publish_javadoc17.sh` script within g3 to use the latest version of the doclet. -## Usage +## Usage ### With `maven-javadoc-plugin`