Skip to content

Update RELEASING.md with Javadoc instructions #5437

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

Closed
chingor13 wants to merge 1 commit into from
Closed

Update RELEASING.md with Javadoc instructions #5437

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
16 changes: 3 additions & 13 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,10 @@ To manually publish the artifacts to Maven (rather than using Kokoro), you will

## Publish Javadoc

1. Run `git clean -x -f -d` to put the repo in a clean state.

2. Locally build the repo by running `mvn install -DskipTests`.

3. Run `python utilities/stage_sites.py`. This script checks out `gh-pages` branch of the
repository, builds the documentation site and javadocs, copies them to the branch and commits it.
This script does not push the docs and it must be done manually on the later step. The script
assumes that there is no directory called `tmp_gh-pages` in the repository root. If it is
present, remove it before running the script.

4. Run `cd tmp_gh-pages && git push && cd ..`.
Javadoc is now built and published to googleapis.dev via a Kokoro job. It is triggered automatically
if the staging job succeeds so there is no manual intervention required.

5. (Optional) Run `rm -rf tmp_gh-pages` to remove the generated docs directory from your local
machine.
You should check back in a few hours to ensure the latest Javadocs are linked at https://googleapis.dev/java/google-cloud-clients/latest.

## Tag the release

Expand Down