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

Docs build is failing due to known issues in proto comments #12326

Closed
parthea opened this issue Feb 16, 2024 · 2 comments
Closed

Docs build is failing due to known issues in proto comments #12326

parthea opened this issue Feb 16, 2024 · 2 comments
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: process A process-related concern. May include testing, release, or the like.

Comments

@parthea
Copy link
Contributor

parthea commented Feb 16, 2024

In release PR #12314, the docs build is failing. See the build log here.

There are known issues with the docs generated in certain clients which can be found here.

While we work to resolve the issue in gapic-generator-python, we could improve the process of applying patches to the release PR to reduce the toil of manually fixing docs issues.
@parthea parthea added type: process A process-related concern. May include testing, release, or the like. priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. labels Feb 16, 2024
@parthea
Copy link
Contributor Author

parthea commented Feb 16, 2024 •
edited
Loading

I'll use this comment to keep track of all of the steps required to resolve the docs build.

This is a work in progress

Cherry pick these commits

git cherry-pick ...

This was referenced Feb 21, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
ohmayr pushed a commit that referenced this issue Feb 21, 2024
@parthea
chore: fix the docs build in google-ai-generativelanguage (#12335)
b1f4e69 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
72c706c 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
This was referenced Feb 21, 2024
Merged
Merged
Merged
Merged
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix the docs build for google-cloud-dms (#12337)
3542c27 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
This was referenced Feb 21, 2024
Merged
Merged
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix the docs in google-cloud-deploy (#12338)
3b33540 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
This was referenced Feb 21, 2024
Merged
Merged
Merged
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix the docs in fix-google-cloud-securitycentermanagement (#12339
fecfdb2 
)

Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-edgenetwork (#12340)
443ae18 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix docs build in google-analytics-admin (#12341)
bebcbf1 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-alloydb (#12342)
df4bcc0 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Feb 21, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-datacatalog (#12343)
6f50db0 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Feb 22, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-network-connectivity (#12356)
f347084 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776


This is a follow up PR as
#12348 did not
include the fix

Co-authored-by: ohmayr <omairnaveed@ymail.com>
parthea added a commit that referenced this issue Mar 4, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-alloydb (#12342)
af1b17a 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
parthea added a commit that referenced this issue Mar 4, 2024
@parthea
chore: fix the docs build in google-ai-generativelanguage (#12335)
af410fc 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776
ohmayr added a commit that referenced this issue Mar 4, 2024
@parthea @ohmayr
chore: fix docs build in google-geo-type (#12351)
2bf4b8c 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

---------

Co-authored-by: ohmayr <omairnaveed@ymail.com>
parthea added a commit that referenced this issue Mar 4, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-datacatalog (#12343)
5cab1b4 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Mar 15, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-datacatalog (#12343)
17538b7 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Mar 15, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
ca01b1b 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Mar 15, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
bf52493 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Mar 18, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
f41232b 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr pushed a commit that referenced this issue Apr 3, 2024
@parthea @ohmayr
chore: fix the docs build in google-ai-generativelanguage (#12335)
cc1c650 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776
ohmayr added a commit that referenced this issue Apr 3, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
799c94c 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Apr 24, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
2289bb4 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue May 7, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-dialogflow-cx (#12345)
2df1a02 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue May 7, 2024
@parthea @ohmayr
chore: fix the docs in google-cloud-deploy (#12338)
492f93c 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr pushed a commit that referenced this issue May 7, 2024
@parthea @ohmayr
chore: fix the docs build in google-ai-generativelanguage (#12335)
41f3f80 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776
ohmayr added a commit that referenced this issue May 10, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
5ae845d 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Jun 5, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
12bbee4 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Jun 20, 2024
@parthea @ohmayr
chore: fix the docs in fix-google-cloud-securitycentermanagement (#12339
69d026c 
)

Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Jun 24, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
fc4d2a7 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Jun 24, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
7909b0f 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix docs build in google-analytics-admin (#12341)
155d91f 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix the docs in google-cloud-deploy (#12338)
10bdd8f 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
a96cd71 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
86955c6 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix the docs build in google-cloud-network-management (#12336)
18fa529 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix docs build in google-cloud-documentai (#12346)
85d0a82 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix the docs in google-cloud-deploy (#12338)
b141be4 
Towards #12326 🦕

See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
ohmayr added a commit that referenced this issue Aug 8, 2024
@parthea @ohmayr
chore: fix docs build in google-analytics-admin (#12341)
81d5975 
Towards #12326 🦕


See googleapis/gapic-generator-python#1776

Co-authored-by: ohmayr <omairnaveed@ymail.com>
@parthea
Copy link
Contributor Author

parthea commented Jan 27, 2025

Closing as obsolete. These patches are no longer applied manually.

@parthea parthea closed this as completed Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@parthea