Skip to content

chore: clarify the release process #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jinseopkim0 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: clarify the release process #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions third_party/docfx-doclet-143274/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<minor>.<patch> -m "<What the new release includes>"`
`git tag -a v1.<minor>.<patch> <SHA of commit> -m "chore: release v1.<minor>.<patch>"`

`git push origin v1.<minor>.<patch>`

3) Update the `publish_javadoc17.sh` script within g3 to use the latest version of the doclet.

## Usage
## Usage

### With `maven-javadoc-plugin`

Expand Down