Automate README integrations index generation and enforce drift checks on PRs#1464
Open
aaronpowell with Copilot wants to merge 8 commits into
Open
Automate README integrations index generation and enforce drift checks on PRs#1464aaronpowell with Copilot wants to merge 8 commits into
aaronpowell with Copilot wants to merge 8 commits into
Conversation
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Review documentation for integrations and deprecated packages
Automate README integrations index generation and enforce drift checks on PRs
Jul 9, 2026
Member
|
@copilot can you do it as a C# file-based app rather than Python? |
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Contributor
Author
Done in |
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1464Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1464" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes the root README.md integrations list reproducible by generating it from the src/**/CommunityToolkit.Aspire*.csproj set, and adds CI enforcement to prevent drift.
Changes:
- Replaced the hand-maintained README integrations rows with a bounded autogenerated region (BEGIN/END markers).
- Added a C# generator script to render the integrations table from project metadata (and flag deprecated integrations based on README text).
- Added a PR workflow to fail when the README’s generated table is stale.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces manual integrations table with an autogenerated block controlled by BEGIN/END markers. |
| eng/scripts/generate-readme-integrations.cs | Adds generator/check script to render and/or validate the README integrations table. |
| .github/workflows/readme-integrations-check.yml | Adds PR-time drift detection by running the generator in --check mode. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Low
Comment on lines
+19
to
+24
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Verify README integrations table is up to date | ||
| run: dotnet run eng/scripts/generate-readme-integrations.cs -- --check |
Comment on lines
+23
to
+24
| - name: Verify README integrations table is up to date | ||
| run: dotnet run eng/scripts/generate-readme-integrations.cs -- --check |
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Contributor
|
Odonno
reviewed
Jul 9, 2026
| return null; | ||
| } | ||
|
|
||
| static string RenderTable(List<Integration> integrations) |
Contributor
There was a problem hiding this comment.
suggestion: wouldn't all that be easier with a StringBuilder?
Member
There was a problem hiding this comment.
@copilot lines would be better served as a StringBuilder in our opinion.
Contributor
Author
There was a problem hiding this comment.
Updated in ccbfca1: RenderTable now uses a StringBuilder for lines, while preserving the same output formatting and check behavior.
| const string TableStart = "<!-- BEGIN AUTOGENERATED INTEGRATIONS TABLE -->"; | ||
| const string TableEnd = "<!-- END AUTOGENERATED INTEGRATIONS TABLE -->"; | ||
|
|
||
| bool checkOnly = args.Contains("--check", StringComparer.OrdinalIgnoreCase); |
Contributor
There was a problem hiding this comment.
suggestion: I would advise check being the default behavior and passing --write to write the new readme
Member
There was a problem hiding this comment.
I think having write as the default behaviour makes sense, since the only real reason you'd be running this as a human is to generate the README updates, and --check is just for CI to do pass/fail.
Contributor
There was a problem hiding this comment.
This is not what a human would expect. I mostly see a --fix or --write in CLI. But since we are in the AI era now, I let you have the final decision.
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Odonno
approved these changes
Jul 11, 2026
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.
The root README integrations list had drifted from the actual package set (e.g., missing SeaweedFS), and deprecated integrations were not consistently surfaced. This change makes the list generated from source projects and enforces freshness in PRs.
Autogenerated integrations table in
README.md<!-- BEGIN AUTOGENERATED INTEGRATIONS TABLE --><!-- END AUTOGENERATED INTEGRATIONS TABLE -->src/**/CommunityToolkit.Aspire*.csprojand sorted alphabetically by package ID.src/(hosting/client/extensions).Generator script for repeatable updates
eng/scripts/generate-readme-integrations.py.⚠️ **Deprecated** — ....PR-time drift detection workflow
.github/workflows/readme-integrations-check.yml.contents: read).