Skip to content
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

Jump to bottom

chore(internal/postprocessor): update README #7954

Merged
merged 1 commit into from
May 16, 2023
Merged

chore(internal/postprocessor): update README #7954

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
36 changes: 3 additions & 33 deletions internal/postprocessor/README.md
View file
Open in desktop
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
``