Follow instructions in OwlBot Usage Guide - “How will I test my .github/.OwlBot.yaml file” using the instructions for split repositories. Note, if you replace step 2 with a clone of your own fork of the googleapis/googleapis-gen.git
repo, you can see how changes in your forked googleapis-gen
repo are eventually propagated through to the library without making changes to the protos. Lack of permissions may also force you to clone a fork instead of the repo.
After following these steps the generated code will have replaced corresponding files in the google-cloud-go
repo.
You can verify the name of the docker container name can be found in the .github/OwlBot.yaml
and github/OwlBot.lock.yaml
files.
In the google-cloud-go
root directory:
docker pull gcr.io/cloud-devrel-public-resources/owlbot-go:latest docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo gcr.io/cloud-devrel-public-resources/owlbot-go:latest
After making changes to the post-processor, you need to publish a new version of the post-processor docker container and manually update the which version of the post-processor is used by OwlBot. To do this you need to update the SHA in the OwlBot lock file.
In your google-cloud-go
repo, create a branch.
Make changes to the post-processor.
Test your changes. You can run the post-processor locally on selected clients or on all of the clients in the root directory. If the branch
flag is empty/unset, the post-processor will exit early without changes. In the google-cloud-go/internal/postprocessor
directory:
go run . -client-root="../.." -googleapis-dir="/path/to/local/googleapis" -branch="my-branch"
To test only selected clients:
go run . -client-root="../.." -googleapis-dir="/path/to/local/googleapis" -branch="my-branch" -dirs="accessapproval,asset"
Clean up any changes made by post-processor test runs in the previous step.
Commit your changes.
Open your PR and respond to feedback.
After your PR is approved and CI is green, merge your changes. An automated job should update the SHA of the post-processor docker image in google-cloud-go/.github/.OwlBot.lock.yaml
.
After making changes to this package land in main
, a new Docker image will be built and pushed automatically. To update the image version used by OwlBot, run the following commands (you will need Docker installed and running):
docker pull gcr.io/cloud-devrel-public-resources/owlbot-go:latest LATEST=`docker inspect --format='{{index .RepoDigests 0}}' gcr.io/cloud-devrel-public-resources/owlbot-go:latest` sed -i -e 's/sha256.*/'${LATEST#*@}'/g' ./.github/.OwlBot.lock.yaml
Note: If run on macOS, the sed -i
flag will need a ''
after it.
Send a pull request with the updated .github/.OwlBot.lock.yaml
.
Note: Any open OwlBot PR will need to be caught-up and the postprocessor rerun to capture the changes.
The post-processor initializes new modules by generating the required files internal/version.go
, go.mod
, README.md
and CHANGES.md
.
To add a new module, add the directory name of the module to modules
in google-cloud-go/internal/postprocessor/config.yaml
. Please maintain alphabetical ordering of the module names.
The validate
command is run as a presubmit on changes to either the .github/.OwlBot.yaml
or the internal/postprocessor/config.yaml
.
If you want to run it manually, from the repository root, simply run the following:
go run ./internal/postprocessor validate
If you want to validate existence of service config yaml in the PostProcessor config, provide an absolute path to a local clone of googleapis
:
go run ./internal/postprocessor validate -googleapis-dir=$GOOGLEAPIS
If you want validate a specific config file, not the repository default, then provide aboslute paths to either or both config files like so:
go run ./internal/postprocessor \ -owl-bot-config=$OWL_BOT_YAML \ -processor-config=$CONFIG_YAML
If you think there is an issue with the validator, just fix it in the same CL as the config change that triggered it. No need to update the postprocessor sha when the validate command is changed, it runs from HEAD of the branch.