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.

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

docs: Update README #12543

Merged
merged 8 commits into from Apr 3, 2024
Merged

docs: Update README #12543

merged 8 commits into from Apr 3, 2024

Conversation

cojenco
Copy link
Contributor

@cojenco cojenco commented Apr 2, 2024

It seems like we can update google-cloud-storage-control repo metadata directly. Please LMK if the patch should be made elsewhere.

Fixes #12532

@cojenco cojenco requested a review from a team as a code owner April 2, 2024 23:56
Copy link
Contributor

@parthea parthea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please re-generate README.rst using the instructions in #12543 (comment) otherwise manual changes made to README.rst will be reverted in the next owlbot PR. The source of truth for the README.rst template is here.

packages/google-cloud-storage-control/.repo-metadata.json Outdated Show resolved Hide resolved
packages/google-cloud-storage-control/.repo-metadata.json Outdated Show resolved Hide resolved
@@ -1,9 +1,9 @@
Python Client for Cloud Storage
===============================
Python Client for Storage Control API
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is automatically generated using information in .repo-metadata.json however you can generate the file locally. In a branch of google-cloud-python, run the following commands

Pull the latest docker image

  • docker pull gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest

create a directory which will signal the post processor to regenerate templated files

  • mkdir -p owl-bot-staging/google-cloud-storage-control

Run the post processor locally

  • docker run --user $(id -u):$(id -g) --rm -v $(pwd):/repo -w /repo gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest

Restore autogenerated samples which are erroneously removed as a result of using this process

  • git checkout packages/google-cloud-storage-control/samples

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parthea Thank you for the instructions! Ran post processor and successfully regenerated the README file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to trigger owlbot post processor, if needed? I don't seem to have access to any label triggers. Appreciate any help to merge the PR :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

packages/google-cloud-storage-control/.repo-metadata.json Outdated Show resolved Hide resolved
@parthea parthea added the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 3, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Apr 3, 2024
@parthea parthea enabled auto-merge (squash) April 3, 2024 21:47
@parthea parthea disabled auto-merge April 3, 2024 21:47
@parthea parthea changed the title chore: update storage control repo metadata docs: Update README Apr 3, 2024
@parthea parthea enabled auto-merge (squash) April 3, 2024 21:47
@parthea parthea merged commit 30b7a8f into googleapis:main Apr 3, 2024
16 checks passed
@release-please release-please bot mentioned this pull request Apr 3, 2024
ohmayr pushed a commit that referenced this pull request Apr 4, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>google-cloud-advisorynotifications: 0.3.8</summary>

##
[0.3.8](google-cloud-advisorynotifications-v0.3.7...google-cloud-advisorynotifications-v0.3.8)
(2024-04-04)


### Features

* add GetSettings and UpdateSettings methods at the Project-level to
advisorynotifications.googleapis.com
([b8a4835](b8a4835))


### Documentation

* adding docs for new project level settings methods
([b8a4835](b8a4835))
</details>

<details><summary>google-cloud-batch: 0.17.17</summary>

##
[0.17.17](google-cloud-batch-v0.17.16...google-cloud-batch-v0.17.17)
(2024-04-04)


### Documentation

* A comment for field `max_run_duration` in message
`.google.cloud.batch.v1alpha.TaskSpec` and
`.google.cloud.batch.v1.TaskSpec` is changed
([3d35d8b](3d35d8b))
* add non-negative restriction comment for
usage_resource_allowance.spec.limit.limit exposed on v1alpha
([3d35d8b](3d35d8b))
* state one Resource Allowance per region per project limitation on
v1alpha
([3d35d8b](3d35d8b))
</details>

<details><summary>google-cloud-securitycenter: 1.30.1</summary>

##
[1.30.1](google-cloud-securitycenter-v1.30.0...google-cloud-securitycenter-v1.30.1)
(2024-04-04)


### Documentation

* Fixed backtick and double quotes mismatch in security_marks.proto
([22201e2](22201e2))
</details>

<details><summary>google-cloud-speech: 2.26.0</summary>

##
[2.26.0](google-cloud-speech-v2.25.1...google-cloud-speech-v2.26.0)
(2024-04-04)


### Features

* add `translation_config` in `RecognitionConfig` message
([4ed87f1](4ed87f1))
</details>

<details><summary>google-cloud-storage-control: 0.1.2</summary>

##
[0.1.2](google-cloud-storage-control-v0.1.1...google-cloud-storage-control-v0.1.2)
(2024-04-04)


### Documentation

* Update README
([#12543](#12543))
([30b7a8f](30b7a8f))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inaccurate fields in storage-control .repo-metadata.json
3 participants