Conversation
|
😎 Merged manually by @abhimehro - details. |
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
There was a problem hiding this comment.
Pull request overview
This PR addresses documentation inconsistencies and adds a missing CI test workflow for pull requests. It standardizes testing instructions to use uv run pytest throughout the README, fixes a placeholder clone URL, and introduces automated test validation on PRs.
Changes:
- Fixed clone URL from placeholder
your-usernameto actual repository ownerabhimehro - Standardized all testing commands in README.md to use
uv run pytest tests/for consistency with theuv sync-based Quick Start - Updated test count reference from ~78 to ~95 tests to reflect current test suite size
- Added new
.github/workflows/test.ymlto automatically run tests on push/PR to main branch
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Fixed clone URL placeholder, standardized all pytest commands to use uv run prefix, updated test count to ~95 |
| .github/workflows/test.yml | New CI workflow for automated test execution on push/PR events |
.github/workflows/test.yml
Outdated
| - name: Install dependencies | ||
| run: | | ||
| pip install -r requirements.txt | ||
| pip install pytest pytest-mock pytest-xdist | ||
|
|
||
| - name: Run tests | ||
| run: pytest tests/ -v |
There was a problem hiding this comment.
The README.md was updated to standardize all testing instructions to use uv run pytest tests/ (consistent with the uv sync-based Quick Start), but this workflow still uses pip install + bare pytest. This creates a discrepancy between the documented approach and the CI implementation.
Consider using uv in the workflow to match the documented approach:
- Install uv (e.g., via
astral-sh/setup-uv@v4) - Run
uv syncto install dependencies including dev dependencies - Run
uv run pytest tests/ -v
This would ensure CI uses the same dependency resolution and execution environment that developers use locally.
There was a problem hiding this comment.
Done in 067e532. The workflow now uses astral-sh/setup-uv@v4 + uv sync --all-extras + uv run pytest tests/ -v, matching the developer workflow documented in the README.
There was a problem hiding this comment.
H @copilot, please apply changes based on the comments in this thread.
Also, thanks so much for working on these issues!
On the README change:
Gemini's note from another Pull Request Thread (#345) intiated by another contributor is worth taking seriously. Using your-username (or YOUR_USERNAME) as a placeholder is the safer pattern, especially since the docs walk contributors through forking first. If someone clones directly from abhimehro:main instead of their fork, they'll hit push permission errors down the line. Want to swap it back to a placeholder with a short note clarifying the fork-first flow?
On the failing check:
The contributor was right about a Cl workflow, that wasn't on them. The copilot-setup-steps workflow uses pull_request, which restricts the token to read-only for fork-based PRs. The createComment() call at line 55 will 403 every time for external contributors. Could we look at migrating it to pull_request_target, or marking it non-required so it doesn't block otherwise clean PRs.
Next steps: - Swap the clone URL to a placeholder (or add an inline comment pointing contributors to substitute their username) - Handle the workflow fix on my end Appreciate them flagging the CI issue proactively. That kind of context saves a lot of back and forth!
Thanks again for your assistance with these important improvements!
…h fork note Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
Both changes addressed in 067e532:
The |
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
Several documentation inconsistencies and a missing CI test workflow left contributors with incorrect setup instructions and no automated test gate on PRs.
Changes
README.md
YOUR_USERNAMEplaceholder with an explicit "Fork first" note — prevents contributors from accidentally cloning upstream and hitting push permission errorspip install pytest...+ barepytestcalls withuv run pytest tests/— consistent with theuv sync-based Quick Start; update test count ~78 → ~95uv run pytestconsistency fix.github/workflows/test.yml(new)Dedicated test validation workflow — runs pytest on
push/pull_requesttomainusinguvto match the documented developer workflow:Uses the same dependency resolver and lock file that developers use locally. Permissions scoped to
contents: read.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.