docs: fix README CI/CD workflow documentation and test commands#398
Merged
docs: fix README CI/CD workflow documentation and test commands#398
Conversation
|
Merging to
|
- Add CI/CD Workflows table (sync.yml, bandit.yml, codacy.yml) with trigger conditions and purposes to clarify actual workflow structure - Update Testing and Release Process sections to use `uv run pytest` (consistent with dev deps in pyproject.toml optional-dependencies) - No ci.yml references remain in README Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix README reference to existing CI workflows
docs: fix README CI/CD workflow documentation and test commands
Feb 20, 2026
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
There was a problem hiding this comment.
Pull request overview
This PR enhances the README documentation by adding a structured CI/CD workflows table and updating all testing commands to use the uv dependency manager, improving consistency with the project's actual CI configuration and dependency management approach.
Changes:
- Added a CI/CD Workflows subsection with a comprehensive table documenting sync.yml, bandit.yml, and codacy.yml workflows, including their triggers and purposes
- Replaced all test command examples from
pip install pytest pytest-mock pytest-xdist+ barepytesttouv sync --all-extras+uv run pytest, aligning with pyproject.toml's optional dependencies structure and the performance.yml workflow pattern
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.
README lacked a structured explanation of the actual CI/CD workflows (
sync.yml,bandit.yml,codacy.yml) and the Testing/Release sections usedpip install pytest+ barepytest— inconsistent with dev deps living inpyproject.tomloptional-dependencies.Changes
CI/CD Workflows table — added
### CI/CD Workflowssubsection under the existing## CI/CD & Dependency Cachingsection, listing each workflow file with its trigger and purpose:sync.ymlmain.pyto sync Control D foldersbandit.ymlmain, weeklycodacy.ymlmain, weeklyTesting commands — replaced
pip install pytest pytest-mock pytest-xdist+ barepytest tests/withuv sync --all-extras+uv run pytest tests/across the Testing and Release Process sections, matching the actual dev dependency setup inpyproject.toml.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.