-
Notifications
You must be signed in to change notification settings - Fork 0
chore(ci): validate action metadata conventions #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
Closed
Closed
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,36 @@ | ||
| name: Validate Action Metadata | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| action-metadata: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Run actionlint | ||
| uses: reviewdog/actionlint@v1 | ||
|
|
||
| - name: Verify action runtime and entrypoint convention | ||
| run: | | ||
| set -euo pipefail | ||
| failed=0 | ||
| while IFS= read -r action_file; do | ||
| if ! grep -Eq "^[[:space:]]*using:[[:space:]]*'node20'[[:space:]]*$" "$action_file"; then | ||
| echo "[ERROR] $action_file must set runs.using to 'node20'" | ||
| failed=1 | ||
| fi | ||
| if ! grep -Eq "^[[:space:]]*main:[[:space:]]*'dist/index.js'[[:space:]]*$" "$action_file"; then | ||
| echo "[ERROR] $action_file must set runs.main to 'dist/index.js'" | ||
| failed=1 | ||
| fi | ||
| done < <(find . -mindepth 2 -maxdepth 2 -type f -name action.yml | sort) | ||
|
|
||
| if [ "$failed" -ne 0 ]; then | ||
| exit 1 | ||
| fi | ||
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 |
|---|---|---|
|
|
@@ -18,4 +18,4 @@ inputs: | |
| required: false | ||
| runs: | ||
| using: 'node20' | ||
| main: 'dist/index.js' | ||
| main: 'dist/index.js' | ||
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.
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.
The convention step only checks whether a line matching
using: 'node20'/main: 'dist/index.js'appears anywhere in the file, so it can pass invalid metadata when those strings appear in comments, examples, or unrelated sections whileruns.using/runs.mainare actually different. In that scenario the workflow reports success even though the action runtime/entrypoint convention is violated, which defeats the purpose of this guard; using a YAML-aware check (oryqonruns.*) would make the validation semantic rather than textual.Useful? React with 👍 / 👎.