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 build failed in google-cloud-deploy #1887

Open
parthea opened this issue Dec 7, 2023 · 0 comments
Open

docs build failed in google-cloud-deploy #1887

parthea opened this issue Dec 7, 2023 · 0 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@parthea
Copy link
Contributor

parthea commented Dec 7, 2023

See https://github.com/googleapis/googleapis/blob/42231337d84e862d417b6d3fd6af50ba0fcf932c/google/cloud/deploy/v1/cloud_deploy.proto#L1607-L1609 where there is an asterisk character which is not surrounded by backticks or escaped.

This caused the docs build to fail with

sphinx.errors.SphinxWarning: /usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-deploy/google/cloud/deploy_v1/types/cloud_deploy.py:docstring of google.cloud.deploy_v1.types.cloud_deploy.SkaffoldModules.SkaffoldGCSSource:5:Inline emphasis start-string without end-string.

Warning, treated as error:
/usr/local/google/home/partheniou/git/google-cloud-python/packages/google-cloud-deploy/google/cloud/deploy_v1/types/cloud_deploy.py:docstring of google.cloud.deploy_v1.types.cloud_deploy.SkaffoldModules.SkaffoldGCSSource:5:Inline emphasis start-string without end-string.

Instead of

  message SkaffoldGCSSource {
    // Required. Cloud Storage source paths to copy recursively. For example,
    // providing "gs://my-bucket/dir/configs/*" will result in Skaffold copying

It should be

  message SkaffoldGCSSource {
    // Required. Cloud Storage source paths to copy recursively. For example,
    // providing `gs://my-bucket/dir/configs/*` will result in Skaffold copying

See https://github.com/googleapis/google-cloud-python/actions/runs/7128004971/job/19409110301?pr=12079

We should add a linter rule to check for unsupported formatting in proto comments via https://github.com/googleapis/api-linter .

@parthea parthea added type: cleanup An internal cleanup or hygiene concern. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Dec 7, 2023
parthea added a commit to googleapis/google-cloud-python that referenced this issue Jan 9, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 1, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 4, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Feb 21, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Mar 5, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue Apr 19, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 11, 2024
parthea added a commit to googleapis/google-cloud-python that referenced this issue May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant