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

Registry tool: store check results as artifacts #1139

Open
timburks opened this issue Apr 4, 2023 · 2 comments
Open

Registry tool: store check results as artifacts #1139

timburks opened this issue Apr 4, 2023 · 2 comments

Comments

@timburks
Copy link
Contributor

timburks commented Apr 4, 2023

To support downstream analysis (e.g. scoring), I think it would be useful to store registry check results in the registry as artifacts. I'm not certain about this but am inclined to want check results in two places: at the root of the project (in a project artifact) and under an API (in an API artifact), with only project-level concerns in the project artifact (mainly issues with top-level artifacts) and everything related to APIs in the API-level artifact. That would make it easier to score APIs based on their check status. ?

@theganyo
Copy link
Member

theganyo commented Apr 4, 2023

A check can be run on a subset of a project and for a subset of rules. How should we determine when to update these artifacts?

@timburks timburks moved this to Todo in Apigee API Registry Apr 5, 2023
@timburks timburks moved this from Todo to Done in Apigee API Registry Apr 5, 2023
@timburks timburks moved this from Done to Todo in Apigee API Registry Apr 5, 2023
@timburks timburks moved this from Todo to Concerning in Apigee API Registry Apr 5, 2023
@timburks
Copy link
Contributor Author

timburks commented Apr 11, 2023

  1. "for a subset of rules" If we think of check as being like a linter, we might have something comparable to a style guide in the registry that lists the default rules for the registry. Checks that use these defaults could be the ones that are written to artifacts. For the time being, we might just accept any registry check run on projects or APIs as the check we want to remember.
  2. "on a subset of a project" I think the resources of interest would be primarily projects and APIs, so as mentioned above, I would like to find check results for an APIs subtree on the API. I'm not sure that I care to support directly running registry check on subresources of APIs (deployments, versions, specs), but these could run and produce output only, not attaching any results to the registry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Concerning
Development

No branches or pull requests

2 participants