Skip to content

docs: fix README CI/CD workflow documentation and test commands#398

Merged
abhimehro merged 2 commits intomainfrom
copilot/fix-readme-ci-workflow-reference
Feb 28, 2026
Merged

docs: fix README CI/CD workflow documentation and test commands#398
abhimehro merged 2 commits intomainfrom
copilot/fix-readme-ci-workflow-reference

Conversation

Copy link

Copilot AI commented Feb 20, 2026

README lacked a structured explanation of the actual CI/CD workflows (sync.yml, bandit.yml, codacy.yml) and the Testing/Release sections used pip install pytest + bare pytest — inconsistent with dev deps living in pyproject.toml optional-dependencies.

Changes

  • CI/CD Workflows table — added ### CI/CD Workflows subsection under the existing ## CI/CD & Dependency Caching section, listing each workflow file with its trigger and purpose:

    Workflow File Trigger Purpose
    Sync sync.yml Daily 02:00 UTC, manual dispatch Runs main.py to sync Control D folders
    Bandit bandit.yml Push/PR to main, weekly Python security vulnerability scanning
    Codacy codacy.yml Push/PR to main, weekly Code quality analysis + SARIF upload
  • Testing commands — replaced pip install pytest pytest-mock pytest-xdist + bare pytest tests/ with uv sync --all-extras + uv run pytest tests/ across the Testing and Release Process sections, matching the actual dev dependency setup in pyproject.toml.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Code Quality] Fix README reference to non-existent ci.yml workflow</issue_title>
<issue_description>### Description

The README.md references .github/workflows/ci.yml which doesn't exist in the repository. This creates confusion for contributors trying to understand the CI/CD setup.

Problem

From the Backlog Burner discussion (#221) and QA Report (#337):

  • README mentions .github/workflows/ci.yml
  • This workflow file doesn't exist
  • Actual CI workflows are sync.yml, bandit.yml, codacy.yml

Current State

Documentation references a non-existent workflow file, causing confusion about which workflows handle CI validation.

Suggested Changes

  1. Replace ci.yml references with actual workflow names:

    • Use sync.yml for main build/test workflow
    • Mention bandit.yml for security scanning
    • Reference codacy.yml for code quality checks
  2. Add CI/CD section to README explaining the workflow structure:

    ### CI/CD Workflows
    - **sync.yml**: Main synchronization workflow
    - **bandit.yml**: Security vulnerability scanning  
    - **codacy.yml**: Code quality analysis
  3. Update any workflow status badges to point to correct workflows

Files Affected

  • README.md (search and replace ci.yml references, add CI/CD section)

Success Criteria

  • ✅ All workflow references point to files that exist
  • ✅ CI/CD section clearly explains workflow purposes
  • ✅ Status badges (if any) link to correct workflows
  • ✅ No broken links in README

Priority

Medium - Documentation accuracy for contributors

Effort Estimate

10 minutes (search/replace + brief documentation addition)

Source

Extracted from Daily Backlog Burner discussion abhimehro/ctrld-sync#221 and QA Report abhimehro/ctrld-sync#337

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent

To install this workflow, run gh aw add github/gh-aw/.github/workflows/discussion-task-miner.md@94662b1dee8ce96c876ba9f33b3ab8be32de82a4. View source at https://github.com/github/gh-aw/tree/94662b1dee8ce96c876ba9f33b3ab8be32de82a4/.github/workflows/discussion-task-miner.md.

  • expires on Feb 20, 2026, 5:44 AM UTC

Comments on the Issue (you are @copilot in this section)

Custom agent used: Development Partner
The Development Partner Protocol


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@trunk-io
Copy link

trunk-io bot commented Feb 20, 2026

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

- 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
Copilot AI requested a review from abhimehro February 20, 2026 03:38
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 22, 2026
@github-actions
Copy link

👋 Development Partner is reviewing this PR. Will provide feedback shortly.

@abhimehro abhimehro marked this pull request as ready for review February 22, 2026 10:18
Copilot AI review requested due to automatic review settings February 22, 2026 10:18
@github-actions
Copy link

👋 Development Partner is reviewing this PR. Will provide feedback shortly.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 + bare pytest to uv sync --all-extras + uv run pytest, aligning with pyproject.toml's optional dependencies structure and the performance.yml workflow pattern

@cursor cursor bot enabled auto-merge (squash) February 26, 2026 23:36
@abhimehro abhimehro merged commit e720eb0 into main Feb 28, 2026
36 checks passed
@abhimehro abhimehro deleted the copilot/fix-readme-ci-workflow-reference branch February 28, 2026 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Code Quality] Fix README reference to non-existent ci.yml workflow

3 participants