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

chore: add component compliance checker #5859

Closed
wants to merge 2 commits into from
Closed

Conversation

bshaffer
Copy link
Contributor

@bshaffer bshaffer commented Feb 7, 2023

This allows us to export a list of all our components with the following fields:

  • Proto package
  • Composer package name
  • Github Repo
  • PHP namespace
  • Component name
  • List of compliance errors

For example, to check the compliance of Workflows:

$ dev/google-cloud check-compliance --component Workflows
+------------------------+------------------------+---------------------------------------+------------------------+-----------+-------------------+
| Protobuf package       | Composer package       | GitHub repo                           | PHP namespace          | Component | Validation errors |
+------------------------+------------------------+---------------------------------------+------------------------+-----------+-------------------+
| google.cloud.workflows | google/cloud-workflows | googleapis/google-cloud-php-workflows | Google\Cloud\Workflows | Workflows |                   |
+------------------------+------------------------+---------------------------------------+------------------------+-----------+-------------------+

To export everything to a CSV:

dev/google-cloud check-compliance --csv component-compliance.csv

One of the goals of this tool is to keep track of all the components and their corresponding repositories. Another goal is to provide an automated check for new components, to ensure that everything is in compliance

@bshaffer bshaffer requested review from a team as code owners February 7, 2023 22:34
@bshaffer
Copy link
Contributor Author

This is being rolled into #5861

@bshaffer bshaffer closed this Feb 23, 2023
@bshaffer bshaffer deleted the components-script branch February 23, 2023 18:49
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.

1 participant