docs(prompts): align install / runbook / test-writer with LISA loader and CI lint#4527
Open
LiliDeng wants to merge 1 commit into
Open
docs(prompts): align install / runbook / test-writer with LISA loader and CI lint#4527LiliDeng wants to merge 1 commit into
LiliDeng wants to merge 1 commit into
Conversation
… and CI lint - install-lisa: capture LISA_HOME / PYTHON / VENV after install, write them to /memories/session/lisa-install.md, set env vars, and add troubleshooting for venv-related 'lisa not found' / wrong Python. Require verifying the running LISA's root via python -c 'import lisa, pathlib; print(pathlib.Path(lisa.__file__).parent.parent)' and recording that path (not pwd) as LISA_HOME. - lisa_runbook_generator: add Step 0 to resolve LISA_HOME (session memory -> env var -> workspace probe -> ask user) before emitting YAML; require absolute extension: paths (Rule 8); reflect venv activation in the run command shown to the user; add troubleshooting for ModuleNotFoundError: No module named 'microsoft'. Document _fix_path_for_old_code_layout semantics so 'import_builtin_tests: true' is the primary pattern for microsoft tests. - lisa_test_writer: add Step 9 Lint Gate documenting the CI stack (black, isort, flake8, mypy, pylint) inline so generated test cases satisfy pyproject.toml / pylintrc, and require running the five local commands before reporting completion.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Copilot prompt docs used for LISA install/runbook/test-writing workflows, aiming to better align the guidance with LISA’s runbook loader behavior and the project’s CI linting expectations.
Changes:
- Add a mandatory “Lint Gate” step to the test-writer prompt to require local lint/type-check verification before completion.
- Add a “Locate the executing LISA install” step and clearer guidance around
import_builtin_testsvsextension:for Microsoft testsuite loading in runbooks. - Extend the install prompt with steps to capture and persist
LISA_HOME/PYTHON/VENVin session memory and add troubleshooting for common venv / module import failures.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| .github/prompts/lisa_test_writer.prompt.md | Adds a new mandatory lint/typing gate and local command checklist before declaring generated tests “done”. |
| .github/prompts/lisa_runbook_generator.prompt.md | Adds pre-YAML guidance to resolve the executing LISA root and clarifies correct ways to load Microsoft testsuites. |
| .github/prompts/install-lisa.prompt.md | Adds install-path capture + session-memory recording for LISA_HOME/PYTHON/VENV, plus related troubleshooting. |
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.
install-lisa: capture LISA_HOME / PYTHON / VENV after install, write them to /memories/session/lisa-install.md, set env vars, and add troubleshooting for venv-related 'lisa not found' / wrong Python. Require verifying the running LISA's root via python -c 'import lisa, pathlib; print(pathlib.Path(lisa.file).parent.parent)' and recording that path (not pwd) as LISA_HOME.
lisa_runbook_generator: add Step 0 to resolve LISA_HOME (session memory -> env var -> workspace probe -> ask user) before emitting YAML; require absolute extension: paths (Rule 8); reflect venv activation in the run command shown to the user; add troubleshooting for ModuleNotFoundError: No module named 'microsoft'. Document _fix_path_for_old_code_layout semantics so 'import_builtin_tests: true' is the primary pattern for microsoft tests.
lisa_test_writer: add Step 9 Lint Gate documenting the CI stack (black, isort, flake8, mypy, pylint) inline so generated test cases satisfy pyproject.toml / pylintrc, and require running the five local commands before reporting completion.
Description
Related Issue
Type of Change
Checklist
Test Validation
Key Test Cases:
Impacted LISA Features:
Tested Azure Marketplace Images:
Test Results