Skip to content

Fix inaccurate sync.yml description in README#392

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

Fix inaccurate sync.yml description in README#392
abhimehro merged 2 commits intomainfrom
copilot/fix-readme-ci-workflow-reference

Conversation

Copy link

Copilot AI commented Feb 19, 2026

README line 108 described sync.yml as running a dry-run on PRs, writing plan.json, and uploading artifacts — behavior that belonged to an old ci.yml workflow that no longer exists.

Changes

  • README.md: Updated the sync.yml description to match what the workflow actually does: runs the sync script on a daily schedule and via manual workflow_dispatch.

Before:

The included GitHub Actions workflow (`.github/workflows/sync.yml`) runs a dry-run
daily at 02:00 UTC and on PRs, writes `plan.json`, and uploads it as an artifact for review.

After:

The included GitHub Actions workflow (`.github/workflows/sync.yml`) runs the sync script
daily at 02:00 UTC and can also be triggered manually via workflow dispatch.
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

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):

  • README mentions .github/workflows/ci.yml
  • File doesn't exist in repository
  • Actual main workflow is sync.yml

This causes:

  • Confusion for new contributors
  • Broken documentation links
  • Misleading CI/CD information

Suggested Changes

Update README.md to reference correct workflows:

  1. Find references to ci.yml:

    • Search README for "ci.yml" or ".github/workflows/ci.yml"
  2. Replace with correct workflow:

    • Change to sync.yml (main synchronization workflow)
    • Or update to reference the actual workflow structure
  3. Verify workflow documentation:

    • Ensure all workflow references are accurate
    • Add links to actual workflow files if helpful

Files Affected

  • README.md

Success Criteria

  • All references to ci.yml removed or corrected
  • README accurately reflects actual workflow files
  • No broken workflow references remain
  • Documentation tested by following from scratch

Priority

Medium - Documentation accuracy important for onboarding

Effort Estimate

10-15 minutes (search and replace, verification)

Related

This complements the effort to create a dedicated test.yml workflow (#373). After that PR merges, README should reference both sync.yml and test.yml.

Source

Extracted from Daily Backlog Burner discussion abhimehro/ctrld-sync#221

🔍 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, 9:12 AM UTC

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


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@trunk-io
Copy link

trunk-io bot commented Feb 19, 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.

Co-authored-by: abhimehro <84992105+abhimehro@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix README reference to correct sync.yml workflow Fix inaccurate sync.yml description in README Feb 19, 2026
Copilot AI requested a review from abhimehro February 19, 2026 23:58
@abhimehro abhimehro marked this pull request as ready for review February 20, 2026 00:13
Copilot AI review requested due to automatic review settings February 20, 2026 00:13
@github-actions
Copy link

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 20, 2026
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 fixes an inaccurate description in the README about the sync.yml GitHub Actions workflow. The old description incorrectly stated that the workflow ran on PRs, created plan.json artifacts, and performed dry-runs—behavior that belonged to a non-existent ci.yml workflow. The updated description correctly reflects that sync.yml runs daily at 02:00 UTC via scheduled cron and can be triggered manually via workflow dispatch.

Changes:

  • Updated sync.yml workflow description in README to match actual workflow behavior (scheduled daily run + manual dispatch, no PR triggers or artifacts)

@abhimehro abhimehro merged commit c4a1573 into main Feb 20, 2026
36 of 37 checks passed
@abhimehro abhimehro deleted the copilot/fix-readme-ci-workflow-reference branch February 20, 2026 00:17
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