Skip to content

Commit

Permalink
chore(internal/postprocessor): update README (#7954)
Browse files Browse the repository at this point in the history
  • Loading branch information
quartzmo authored May 16, 2023
1 parent 05bc20e commit 73d68f6
Showing 1 changed file with 3 additions and 33 deletions.
36 changes: 3 additions & 33 deletions internal/postprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,27 +51,9 @@ the OwlBot lock file.
4. Clean up any changes made by post-processor test runs in the previous step.
5. Commit your changes.
6. Open your PR and respond to feedback.
7. Once your PR is complete (but before merging it!), rebuild the post-processor
docker image from your local branch using the
`google-cloud-go/internal/cloudbuild.yaml` Cloud Build configuration. In the
`google-cloud-go` root directory:

```bash
gcloud builds submit --project=cloud-devrel-kokoro-resources --config=internal/cloudbuild.yaml
```
8. Read the SHA of the latest post-processor docker image. In any location:

```bash
docker pull gcr.io/cloud-devrel-public-resources/owlbot-go:latest
docker inspect --format='{{index .RepoDigests 0}}' gcr.io/cloud-devrel-public-resources/owlbot-go:latest
```
9. In your branch, update the SHA of the post-processor docker image in
`google-cloud-go/.github/.OwlBot.lock.yaml`. Commit and push the change to
your PR.

*Note*: OwlBot will eventually open a pull request to update the SHA if it
discovers a new version of the container.
10. After your PR is approved and CI is green, merge your changes.
7. 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`.

## Initializing new modules

Expand All @@ -81,15 +63,3 @@ The post-processor initializes new modules by generating the required files
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.

## cloudbuild.yaml

The `cloudbuild.yaml` Cloud Build configuration currently supports:

* Building the `Dockerfile`.

The build can be run locally in the `google-cloud-go` root directory:

```bash
gcloud builds submit --project=cloud-devrel-kokoro-resources --config=internal/postprocessor/cloudbuild.yaml
``

0 comments on commit 73d68f6

Please sign in to comment.