Repository navigation
Simplify Action docs and use version tags - #8
Merged
Merged
Conversation
Use v0.1.0 in consumer examples, expand optional isolation into a complete three-job workflow, and remove obsolete wrapper and prerelease setup wording. Clarify model-free versus live CI and preserve documented permission risks. Closes #7 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches existing Action behavior and permission boundaries, with only optional clarifications remaining.
No open issues 🎉
What changed in this PR
Updates documentation for the v0.1.0 prerelease of the Vally GitHub Action.
Changes:
- Leads with default usage and adds a complete optional lint/run/report workflow.
- Refreshes example links, security wording, and contributor guidance without runtime changes.
| File | Description |
|---|---|
| SECURITY.md | Clarifies execution authorization and Copilot availability. |
| README.md | Updates released usage and advanced workflow examples. |
| examples/copilot-smoke/README.md | Links to current consumer workflows. |
| CONTRIBUTING.md | Clarifies CI boundaries and release preparation. |
| AGENTS.md | Removes obsolete runtime-bundle wording. |
Review effort: Max
Switch checkout references to v7, document the v0 moving alias for released 0.x versions, and align workflow contract tests and contributor guidance. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
wbreza
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Closes #7.
github/evals-action@v0(currently the v0.1.0 prerelease): one job,one checkout, one Action step, and no command or token inputs.
section, including outputs, job permissions and failure-reporting paths.
versus live CI wording.
actions/checkout@v7in repository workflows, examples, and contributorguidance; retain the existing references for other third-party Actions.
v0after approved 0.x releases while leaving versiontags unchanged. The created
v0tag points to the same commit asv0.1.0.Verification
Read the Action metadata, orchestration, and reporter validation to reconcile
the examples with v0.1.0 behavior. Parsed all README YAML blocks with the
existing YAML library and checked the simple/advanced job layout, permissions,
token inputs, concurrency and local documentation links.
git diff --checkpasses. The targeted example contract test passes with the checkout tag.
No runtime, packaged distribution or dependency changes.
Scope
Documentation and checkout-reference cleanup. Default combined-token permissions
and optional isolated jobs remain as implemented. This PR does not change the
released v0.1.0 tag, repository access or model workload. Moving
v0remainsan explicit release-management step, not an automatic workflow.