-
Notifications
You must be signed in to change notification settings - Fork 1
ci: add reusable plugin-validate workflow for plugin repositories #19
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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,86 @@ | ||
| # Reusable validation workflow for feedBack plugin repositories. | ||
| # | ||
| # Call it from a plugin repo's CI in three lines: | ||
| # | ||
| # jobs: | ||
| # validate: | ||
| # uses: got-feedback/feedBack-plugin-spec/.github/workflows/plugin-validate.yml@main | ||
| # | ||
| # It runs tools/validate.py — the same gate this repo runs on its own | ||
| # examples — against the caller's plugin, so validation logic and the | ||
| # manifest schema stay single-sourced here instead of being vendored | ||
| # (and drifting) in every plugin repo. | ||
| # | ||
| # The plugin is first staged under a directory named after its manifest | ||
| # `id`, so a repository can be named e.g. `feedBack-plugin-foo` while the | ||
| # plugin id is `foo`: spec §5.2 (directory name == id) is enforced against | ||
| # the staged copy, matching how the plugin actually sits inside a Host's | ||
| # plugins/ directory after installation. | ||
|
|
||
| name: plugin-validate | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| plugin-dir: | ||
| description: "Path to the plugin directory inside the caller repository." | ||
| type: string | ||
| required: false | ||
| default: "." | ||
| spec-ref: | ||
| description: "Ref of this spec repository to validate against." | ||
| type: string | ||
| required: false | ||
| default: "main" | ||
|
|
||
| jobs: | ||
| validate: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out plugin | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| path: caller | ||
| persist-credentials: false | ||
|
|
||
| - name: Check out spec | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: got-feedback/feedBack-plugin-spec | ||
| ref: ${{ inputs.spec-ref }} | ||
| path: spec | ||
| persist-credentials: false | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
|
|
||
| - name: Install dependencies | ||
| run: python -m pip install --upgrade jsonschema | ||
|
|
||
| - name: Stage plugin under its manifest id (spec §5.2) | ||
| env: | ||
| PLUGIN_DIR: ${{ inputs.plugin-dir }} | ||
| run: | | ||
| set -eu | ||
| SRC="caller/$PLUGIN_DIR" | ||
| # This step runs *before* validate.py, so the manifest is still | ||
| # untrusted here — the schema's id pattern (^[a-z0-9][a-z0-9_-]*$) | ||
| # has not been enforced yet. Strip any path components and fall back | ||
| # to a placeholder when plugin.json is missing, unreadable, or has no | ||
| # usable id, so a bad manifest yields validate.py's diagnostic rather | ||
| # than a shell traceback or a write outside staged/. | ||
| ID="$(python -c 'import json, os, sys | ||
| try: v = json.load(open(sys.argv[1])).get("id") | ||
| except Exception: v = None | ||
| v = os.path.basename(str(v or "").strip()) | ||
| print(v if v not in ("", ".", "..") else "invalid-manifest")' "$SRC/plugin.json" 2>/dev/null || true)" | ||
| [ -n "$ID" ] || ID="invalid-manifest" | ||
| mkdir -p "staged/$ID" | ||
| cp -R "$SRC/." "staged/$ID/" | ||
| rm -rf "staged/$ID/.git" | ||
| echo "STAGED=staged/$ID" >> "$GITHUB_ENV" | ||
|
|
||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| - name: Validate against the spec | ||
| run: python spec/tools/validate.py "$STAGED" | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.