feat: add new pre-commit hook: validate ibm_catalog.json inputs #1080
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ocofaigh
reviewed
Dec 18, 2024
| from subprocess import PIPE, Popen | ||
|
|
||
| IBM_CATALOG_FILE = "ibm_catalog.json" | ||
| DA_FOLDER = "solutions" |
There was a problem hiding this comment.
not all DAs will be in a solutions folder (for example landing zone in in patterns folder and WatsonX SaaS DA is in root level). The working directory of the DA will be in the ibm_catalog.json. And if its not, it means it defaults to the root directory of the repo.
ocofaigh
reviewed
Dec 18, 2024
| inputs = [] | ||
| with open(IBM_CATALOG_FILE) as f: | ||
| ibm_catalog = json.load(f) | ||
| if ibm_catalog and "products" in ibm_catalog and ibm_catalog["products"]: |
There was a problem hiding this comment.
can you make sure we only do this for "product_kind": "solution", ? Since we also have module types, and they should be excluded from this check
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Check if all solution input variables are defined in ibm_catalog.json file. Same time checks if any input is defined in catalog.json file which is not defined in solutions input.
Release required?
x.x.X)x.X.x)X.x.x)Release notes content
Run the pipeline
If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.
Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:
Checklist for reviewers
For mergers