Skip to content

feat: add validate-metadata action for catalog metadata validation #107

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.

Sign up for GitHub

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

Merged
davidfestal merged 2 commits into from
Jan 29, 2026
Merged

feat: add validate-metadata action for catalog metadata validation #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fedf09
feat: add `validate-metadata` action for catalog metadata validation
jonkoops Jan 26, 2026
c990554
Update .github/workflows/export-dynamic.yaml
davidfestal Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/check-backstage-compatibility.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ jobs:
echo "OVERLAY_REPO=${{ github.repository }}" >> $GITHUB_OUTPUT
fi
- uses: actions/checkout@v4.2.2
name: Checkout overlay repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ steps.set-overlay-repo-ref.outputs.OVERLAY_REPO_REF }}
repository: ${{ steps.set-overlay-repo.outputs.OVERLAY_REPO }}
Expand Down
38 changes: 33 additions & 5 deletions .github/workflows/export-dynamic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ on:
default: false
required: false

target-backstage-version:
description: Target Backstage version for validating OCI tag format in metadata (e.g., "1.42.5")
type: string
required: true

image-repository-prefix:
description: Repository prefix of the dynamic plugin container images
type: string
Expand Down Expand Up @@ -119,6 +124,15 @@ on:
value: '${{ jobs.export.outputs.published-exports }}'
failed-exports:
value: '${{ jobs.export.outputs.failed-exports }}'
metadata-validation-passed:
description: Whether the metadata validation passed (true/false)
value: '${{ jobs.export.outputs.metadata-validation-passed }}'
metadata-validation-errors:
description: JSON array of metadata validation errors, empty array if validation passed
value: '${{ jobs.export.outputs.metadata-validation-errors }}'
metadata-validation-error-count:
description: Number of metadata validation errors found
value: '${{ jobs.export.outputs.metadata-validation-error-count }}'

jobs:
export:
Expand All @@ -136,6 +150,9 @@ jobs:
outputs:
published-exports: '${{ steps.export-dynamic.outputs.published-exports }}'
failed-exports: '${{ steps.export-dynamic.outputs.failed-exports }}'
metadata-validation-passed: '${{ steps.validate-metadata.outputs.validation-passed }}'
metadata-validation-errors: '${{ steps.validate-metadata.outputs.validation-errors }}'
metadata-validation-error-count: '${{ steps.validate-metadata.outputs.validation-error-count }}'

steps:
- name: Validate Inputs
Expand All @@ -155,15 +172,15 @@ jobs:
}

- name: Checkout plugins repository ${{ inputs.plugins-repo }}
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
if: ${{ inputs.plugins-root == '.' }}
with:
repository: ${{ inputs.plugins-repo }}
ref: ${{ inputs.plugins-repo-ref }}
path: source-repo

- name: Checkout plugins repository ${{ inputs.plugins-repo }} at ${{ inputs.plugins-root }}
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
if: ${{ inputs.plugins-root != '.' }}
with:
repository: ${{ inputs.plugins-repo }}
Expand All @@ -177,7 +194,7 @@ jobs:
path: source-repo

- name: Checkout overlay repository ${{ inputs.overlay-repo }} in the 'overlay-repo' sub-folder
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: ${{ inputs.overlay-repo }}
ref: ${{ inputs.overlay-repo-ref }}
Expand Down Expand Up @@ -220,8 +237,8 @@ jobs:
sudo apt-get update
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

- name: Use node.js ${{ inputs.node-version }}
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
- name: Setup Node.js ${{ inputs.node-version }}
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: ${{ inputs.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
Expand Down Expand Up @@ -287,6 +304,16 @@ jobs:
image-tag-prefix: ${{ inputs.image-tag-prefix }}
last-publish-commit: ${{ inputs.last-publish-commit }}

- name: Validate Catalog Metadata
if: ${{ success() && steps.export-dynamic.outputs.workspace-skipped-unchanged-since == 'false' }}
id: validate-metadata
uses: redhat-developer/rhdh-plugin-export-utils/validate-metadata@main
with:
overlay-root: ${{ github.workspace }}/overlay-repo/${{inputs.overlay-root}}
plugins-root: ${{ github.workspace }}/source-repo/${{inputs.plugins-root}}
target-backstage-version: ${{ inputs.target-backstage-version }}
image-repository-prefix: ${{ steps.set-image-tag-name.outputs.IMAGE_REPOSITORY_PREFIX }}

- name: Set artifacts name suffix
id: set-artifacts-name-suffix
shell: bash
Expand Down Expand Up @@ -320,6 +347,7 @@ jobs:
${{ github.workspace }}
!${{ github.workspace }}/dynamic-plugin-archives
!${{ github.workspace }}/node_modules
!.git
if-no-files-found: warn
retention-days: ${{ inputs.artifact-retention-days }}
overwrite: true
Expand Down
16 changes: 15 additions & 1 deletion .github/workflows/export-workspaces-as-dynamic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,18 @@ on:

failed-exports:
value: '${{ jobs.export.outputs.failed-exports }}'

metadata-validation-passed:
description: Whether the metadata validation passed (true/false)
value: '${{ jobs.export.outputs.metadata-validation-passed }}'

metadata-validation-errors:
description: JSON array of metadata validation errors
value: '${{ jobs.export.outputs.metadata-validation-errors }}'

metadata-validation-error-count:
description: Number of metadata validation errors found
value: '${{ jobs.export.outputs.metadata-validation-error-count }}'

jobs:
prepare:
Expand Down Expand Up @@ -131,7 +143,8 @@ jobs:
echo "OVERLAY_REPO=${{ github.repository }}" >> $GITHUB_OUTPUT
fi

- uses: actions/checkout@v4.2.2
- name: Checkout overlay repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
ref: ${{ steps.set-overlay-repo-ref.outputs.OVERLAY_REPO_REF }}
repository: ${{ steps.set-overlay-repo.outputs.OVERLAY_REPO }}
Expand Down Expand Up @@ -226,6 +239,7 @@ jobs:
publish-container: ${{ inputs.publish-container }}
image-repository-prefix: ${{ inputs.image-repository-prefix }}
image-tag-prefix: ${{ inputs.image-tag-prefix != '' && inputs.image-tag-prefix || format('bs_{0}__', needs.prepare.outputs.backstage-version) }}
target-backstage-version: ${{ needs.prepare.outputs.backstage-version }}
last-publish-commit: ${{ inputs.last-publish-commit }}
image-registry-user: ${{ inputs.image-registry-user }}

Expand Down
Loading