-
Notifications
You must be signed in to change notification settings - Fork 7
Feat: Add metadata validation workflow and scripts #6
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
Open
alyssacgoins
wants to merge
1
commit into
kubeflow:main
Choose a base branch
from
alyssacgoins:metadata-validation-workflow
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,271
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: scripts-unit-tests | ||
| env: | ||
| PYTHON_VERSION: 3.11 | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'scripts/validate_metadata/**' | ||
| jobs: | ||
| execute-scripts-unit-tests: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v5 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v6 | ||
| with: | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
|
|
||
| - name: Install test dependencies | ||
| run: | | ||
| pip install -r scripts/validate_metadata/requirements.txt | ||
|
|
||
| - name: Install Test dependencies | ||
| run: | | ||
| pip install -r scripts/validate_metadata/requirements.txt | ||
|
|
||
| - name: Run tests | ||
| run: pytest scripts/validate_metadata |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: validate-metadata-schema | ||
| env: | ||
| PYTHON_VERSION: 3.11 | ||
| RETRIEVAL_SCRIPT_PATH: $GITHUB_WORKSPACE/.github/resources/scripts/get_items_for_validation.sh | ||
| VALIDATION_SCRIPT_PATH: $GITHUB_WORKSPACE/scripts/validate_metadata/validate_metadata.py | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'components/**' | ||
| - 'pipelines/**' | ||
| - 'scripts/**' | ||
| - 'third_party/components/**' | ||
| - 'third_party/pipelines/**' | ||
|
|
||
| jobs: | ||
| validate-metadata-schema: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v5 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v6 | ||
| with: | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
|
|
||
| - name: Install Test dependencies | ||
| run: | | ||
| pip install -r scripts/validate_metadata/requirements.txt | ||
|
|
||
| - name: Retrieve new components and/or pipelines | ||
| id: get-new-items | ||
| run: ${{ env.RETRIEVAL_SCRIPT_PATH }} "${{ github.event.pull_request.base.sha }}" "${{ github.event.pull_request.head.sha }}" validate_metadata | ||
|
|
||
| #ToDo: Utilize .github/scripts/find-changed-components-and-pipelines.sh script once merged in from https://github.com/kubeflow/pipelines-components/pull/7 | ||
| - name: Validate new core/third-party components and/or pipelines | ||
| if: ${{ steps.get-new-items.outputs.new_items_list != '' }} | ||
| run: | | ||
| NEW_ITEMS_ARRAY="${{ steps.get-new-items.outputs.new_items_list }}" | ||
|
|
||
| # Set IFS to a comma, so that the shell will split the string by commas. | ||
| IFS=',' | ||
|
|
||
| for item in $NEW_ITEMS_ARRAY; do | ||
| FILE_PATH="$GITHUB_WORKSPACE/$item" | ||
| echo "Processing item: $item" | ||
| python "${{ env.VALIDATION_SCRIPT_PATH }}" --item $FILE_PATH | ||
| done | ||
Empty file.
Empty file.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| PyYAML==6.0.3 | ||
| semver==3.0.4 | ||
| pytest==7.1.2 |
2 changes: 2 additions & 0 deletions
2
scripts/validate_metadata/test_data/directories_metadata/missing_metadata_file/OWNERS
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| approvers: | ||
| - sample-approver |
22 changes: 22 additions & 0 deletions
22
scripts/validate_metadata/test_data/directories_metadata/missing_owners_file/metadata.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| tier: third_party | ||
| name: happy-path-component | ||
| stability: alpha | beta | stable | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5' | ||
| - name: Trainer | ||
| version: '>=2.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| pytest: optional | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
Empty file.
2 changes: 2 additions & 0 deletions
2
scripts/validate_metadata/test_data/directories_metadata/valid/OWNERS
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| approvers: | ||
| - sample-approver |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/directories_metadata/valid/metadata.yaml
alyssacgoins marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: component_valid | ||
| tier: third_party | ||
| stability: alpha | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '2.5.0' | ||
| - name: Trainer | ||
| version: '2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
20 changes: 20 additions & 0 deletions
20
scripts/validate_metadata/test_data/metadata/invalid/invalid_ci.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| name: invalid-ci | ||
| tier: core | ||
| stability: alpha | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: invalid-ci-value | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
22 changes: 22 additions & 0 deletions
22
scripts/validate_metadata/test_data/metadata/invalid/invalid_ci_category.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: invalid-ci-category | ||
| tier: core | ||
| stability: stable | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| invalid_ci_category: invalid_value | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/metadata/invalid/invalid_ci_dependency_probe.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: invalid-ci-dependency-probe | ||
| tier: third_party | ||
| stability: beta | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: invalid-probe-value | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
24 changes: 24 additions & 0 deletions
24
scripts/validate_metadata/test_data/metadata/invalid/invalid_dependencies_category.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: invalid-dependencies-category | ||
| tier: core | ||
| stability: beta | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| invalid_dependency_category: | ||
| - name: Invalid Dependency | ||
| version: "1.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
13 changes: 13 additions & 0 deletions
13
scripts/validate_metadata/test_data/metadata/invalid/invalid_dependencies_type.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| name: invalid-dependencies-type | ||
| tier: third_party | ||
| stability: alpha | ||
| dependencies: "invalid-dependencies-type" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
21 changes: 21 additions & 0 deletions
21
.../validate_metadata/test_data/metadata/invalid/invalid_dependency_semantic_versioning.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: invalid-dependency-semantic-versioning | ||
| tier: third_party | ||
| stability: stable | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
19 changes: 19 additions & 0 deletions
19
scripts/validate_metadata/test_data/metadata/invalid/invalid_links.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| name: invalid-links | ||
| tier: core | ||
| stability: alpha | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: https://invalid-link |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/metadata/invalid/invalid_name.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: 2 | ||
| tier: core | ||
| stability: beta | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/metadata/invalid/invalid_stability.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: invalid-stability | ||
| tier: third_party | ||
| stability: invalid-stability | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/metadata/invalid/invalid_tag_array_type.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: invalid-tag-array-type | ||
| tier: core | ||
| stability: stable | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - 1 | ||
| - 2 | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
19 changes: 19 additions & 0 deletions
19
scripts/validate_metadata/test_data/metadata/invalid/invalid_tag_type.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| name: invalid-tag-type | ||
| tier: core | ||
| stability: stable | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: "tags" | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
21 changes: 21 additions & 0 deletions
21
scripts/validate_metadata/test_data/metadata/invalid/invalid_tier.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: invalid-tier | ||
| tier: invalid_tier | ||
| stability: alpha | ||
| dependencies: | ||
| kubeflow: | ||
| - name: Pipelines | ||
| version: '>=2.5.0' | ||
| - name: Trainer | ||
| version: '>=2.0.0' | ||
| external_services: | ||
| - name: Argo Workflows | ||
| version: "3.6.0" | ||
| tags: | ||
| - training | ||
| - evaluation | ||
| lastVerified: 2025-03-15T00:00:00Z | ||
| ci: | ||
| skip_dependency_probe: false | ||
| links: | ||
| documentation: https://kubeflow.org/components/happy-path-component | ||
| issue_tracker: https://github.com/kubeflow/kfp-components/issues |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the validate_metadata.py script accepts --component flag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated this argument to --dir