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

Add job to maintain .repo-metadata information #10090

Open
alicejli opened this issue Nov 29, 2023 · 3 comments
Open

Add job to maintain .repo-metadata information #10090

alicejli opened this issue Nov 29, 2023 · 3 comments
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@alicejli
Copy link
Contributor

alicejli commented Nov 29, 2023

The information within the .repo-metdata.json file for each client library module is initially populated during creation of the new client library. After creation, there is not an automated way for the information to get updated.

The fields should come from the Cloud Drop yaml file and ideally there would be a process such that if the Cloud Drop yaml file is updated, the .repo-metadata.json file is also updated.

Many of the fields are used in our external documentation. For instance on the library overview page, the product documentation URL is explicitly linked, and the Enable the API link is created from the api_shortname.

@alicejli alicejli added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Nov 29, 2023
@suztomo
Copy link
Member

suztomo commented Nov 29, 2023

there is not an automated way for the information to get updated.

Would you add any known problems that are caused by the staleness?

@lqiu96 lqiu96 added the priority: p2 Moderately-important priority. Fix may not be included in next release. label Nov 30, 2023
@suztomo
Copy link
Member

suztomo commented Dec 18, 2023

if the Cloud Drop yaml file is updated

About that "if". Am I right that that YAML file is not updated?

@alicejli
Copy link
Contributor Author

if the Cloud Drop yaml file is updated

About that "if". Am I right that that YAML file is not updated?

The YAML file should be maintained and updated by the service owner teams. To your point, they are not typically updated frequently, but they can change.

Currently the .repo-metadata.json file we generate based on the YAML file is not updated automatically after the initial client library creation.

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: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

3 participants