Skip to content

docs: refresh readmes for copilot code review rulesets#47

Open
mtb-xt wants to merge 2 commits intocloudposse-terraform-components:mainfrom
mtb-xt:codex/copilot-readme-refresh-v1.0.0
Open

docs: refresh readmes for copilot code review rulesets#47
mtb-xt wants to merge 2 commits intocloudposse-terraform-components:mainfrom
mtb-xt:codex/copilot-readme-refresh-v1.0.0

Conversation

@mtb-xt
Copy link
Copy Markdown
Contributor

@mtb-xt mtb-xt commented Apr 19, 2026

Summary

Refresh the generated README files after #46 and add a source-of-truth Copilot ruleset example in README.yaml.

What changed

  • update README.yaml with a Copilot code review ruleset example
  • regenerate README.md from the repo's canonical docs workflow
  • regenerate src/README.md from the same source
  • reflect the merged cloudposse/repository/github 1.6.0 module version in docs
  • remove stale generated references to deprecated repository fields and rulesets_etags
  • include the existing update rule in the rendered rulesets schema

Validation

  • atmos docs generate readme
  • atmos docs generate readme-simple

This is a docs-only follow-up to #46.

Summary by CodeRabbit

  • Documentation
    • Added guidance for enabling GitHub Copilot code review through repository rulesets with configuration examples
    • Updated module version documentation and revised input/output schema documentation to reflect the latest supported configuration options

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 654190dd-d8e9-47e3-8f7e-893bab42df79

📥 Commits

Reviewing files that changed from the base of the PR and between 9f12fdb and a3bc3ad.

📒 Files selected for processing (3)
  • README.md
  • README.yaml
  • src/README.md
✅ Files skipped from review due to trivial changes (1)
  • README.yaml

📝 Walkthrough

Walkthrough

Documentation updated to reflect enabling GitHub Copilot code review via repository rulesets, bump the cloudposse/repository/github module from 1.1.0 to 1.6.0, remove deprecated repository fields, add a rules.update boolean, and drop the rulesets_etags output entry.

Changes

Cohort / File(s) Summary
Root README
README.md
Added example and docs for enabling GitHub Copilot code review via a repository ruleset; bumped cloudposse/repository/github from 1.1.01.6.0; removed has_downloads and ignore_vulnerability_alerts_during_read from documented repository inputs; added rules.update = optional(bool, false); removed output_rulesets_etags.
Module README
src/README.md
Mirrors root README changes: documents Copilot ruleset example, module version bump to 1.6.0, removes ignore_vulnerability_alerts_during_read from repository schema, adds rules.update, and removes rulesets_etags output.
YAML docs / examples
README.yaml
Adds usage example demonstrating copilot_code_review ruleset targeting default branch with review_on_push: true (documentation only).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

needs-test

Suggested reviewers

  • goruha

Poem

🐰 A little hop for docs today,
I damp the old fields gently away,
New ruleset options spring and play,
Copilot reviews now find their way,
Hooray for code — let's hop and say! 🥕✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: refreshing README documentation files to include GitHub Copilot code review ruleset examples and updated module version information.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mergify mergify Bot requested review from a team April 19, 2026 07:59
@mergify
Copy link
Copy Markdown

mergify Bot commented Apr 19, 2026

Important

Do not edit the README.md directly. It's auto-generated from the README.yaml

Please update the README.yaml file instead.

Could you fix it @mtb-xt? 🙏

@mergify
Copy link
Copy Markdown

mergify Bot commented Apr 19, 2026

Important

Title is necessary and should not be empty.

Kindly provide a meaningful title for this Pull Request.

@mergify mergify Bot added the triage Needs triage label Apr 19, 2026
@mtb-xt mtb-xt changed the title [codex] regenerate readmes after copilot ruleset merge docs: refresh readmes for copilot code review rulesets Apr 19, 2026
@mtb-xt mtb-xt force-pushed the codex/copilot-readme-refresh-v1.0.0 branch from 9f12fdb to 6d9cf39 Compare April 19, 2026 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Needs triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant