[Feature]: Add CI checks for pull requests
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Read .github/workflows/update_plugin.yaml and script/update_plugin.py first to see how sources are validated and how plugins/index.json is rebuilt, then compare a few files under sources/ with their plugins/*.json counterparts. The issue's own checklist (steps 1 and 2) is the scope to agree on before coding, since the test block and smoke test are still open questions for the maintainers. Done looks like a new pull-request workflow that fails on invalid or orphaned source files.
Written by the indexing model from the issue text.
Description
1. Your usage scenarios?
Pull requests in this repo get no automated checks. I checked PRs 30, 32, 34, 41 and 42, and none of them has a status or a check run. PR 42 was approved and merged with no checks at all. PR 34, a Dependabot bump of actions/checkout, is still open with no checks.
The only workflow is .github/workflows/update_plugin.yaml. It runs every hour and on manual dispatch, never on pull requests. It reads sources/, updates plugins/*.json, rebuilds plugins/index.json, commits the result to the branch and deploys Pages. The registry docs say a merged source is published automatically and checked every hour, so the generated files reach the site without a review.
Some problems I found while reading the repo:
- PR 35 changed
plugins/chaosblade.jsonandplugins/index.jsondirectly, with no file undersources/. The hourly job rebuilds the index fromsources/, so chaosblade is missing fromplugins/index.jsonnow, and the job never updates its file. - The registry docs describe a
testblock in the source file format (version,check,resultRegx). Nothing in this repo reads it. - As far as I can read
script/update_plugin.py, a source whose manifest or zip download fails is only printed. The run still exits 0, and that plugin is left out ofplugins/index.jsonfor that run. ad-m/github-push-action@masteris not pinned to a release or a commit.
2. What is your expected outcome?
A workflow that runs on pull requests and has to pass before merge. These are the checks I would start with, in this order:
- For each changed
sources/*.json: valid JSON,nameandmanifestUrlpresent, and the file name equal toname. - Every
plugins/*.jsonhas a source file, and every source has an entry inplugins/index.json. - Run
script/update_plugin.pyin the check, and fail if any source fails. - For each changed source, install
test.versionwith vfox, runtest.checkand matchtest.resultRegx. This needs a vfox binary and a real download, so it is slower and can be flaky. I would start with Linux only. - Pin third-party actions to a full commit SHA.
Questions for the maintainers:
- Should the hourly job fail when a source fails, or only report it?
- Should the
testblock run in CI, and should new sources be required to have one? - Which systems should the smoke test cover?
Once we agree on the scope, I can send a PR for steps 1 and 2.
- Dominant language
- Python
- Stars
- 32
- Forks
- 21
- Avg merge
- 4h 55m
- Merged PRs (30d)
- 3
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from version-fox/vfox-plugins
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 48/100
version-fox/vfox-plugins#44 · 7 comments ·
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 38/100
version-fox/vfox-plugins#37 ·
-
[Feature]: Add justOpenenhancement help wanted
version-fox/vfox-plugins#49 · 8 comments ·
-
enhancement help wanted
Difficulty 3/5 1-2 days Newbie friendliness 50/100
version-fox/vfox-plugins#56 ·
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 35/100
version-fox/vfox-plugins#43 · 1 reaction ·
All issues in version-fox/vfox-plugins
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
pathintegral-institute/mcpm.sh#568 ·
Maintainers usually reply within 21 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
invarislabs/invaris-agentsec#98 ·
Maintainers usually reply within 1 day
-
5-minutes beginner-friendly documentation good first issue hacktoberfest help wanted no-code-needed python
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Huerte/algo-solutions-python#364 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Becksteinlab/imdclient#161 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day