docs: define Maya E2E consumer contract - #12
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Defines a clear “consuming repo contract” for using the maya-plugin-e2e skill, separating deterministic scenario/test inputs (kept in product repos) from operator-owned/private host and trust configuration (kept outside repos).
Changes:
- Add a “Consuming Repo Contract” section describing what each consuming repository must own (scenario YAML, scripts, docs, routing).
- Document guidance to keep host/trust configuration outside the consuming repo.
Comments suppressed due to low confidence (1)
skills/maya-plugin-e2e/SKILL.md:38
- This section introduces “Host Config” (title case) and a hard requirement on
MAYA_STALL_HOST_CONFIG, but elsewhere the skill uses “host config” and the--host-configflag. To avoid confusion, keep casing consistent and document selection in a way that matches the commands shown (with env var usage as an optional setup detail).
Keep Host Config outside the repo. Prefer a stable operator-owned path such as
`~/.config/maya-stall/hosts.yaml`, selected through `MAYA_STALL_HOST_CONFIG`.
The skill owns the workflow; the consuming repo owns product assertions; the
host config owns private infrastructure and trust policy.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+27
to
+30
| - `.maya-stall.yaml` with named Scenario, `pluginArtifacts`, Maya scripts, | ||
| expected outputs, Visual Evidence, and Validators; | ||
| - a checked-in Maya script that drives real product controls and writes the | ||
| Scenario Result; |
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