generate community extensions index from catalog by DyanGalih · Pull Request #2564 · github/spec-kit

DyanGalih · 2026-05-14T16:43:30Z

What changed

Added a generator for docs/community/extensions.md backed by extensions/catalog.community.json.
Replaced the hand-maintained community extensions table with a generated index block.
Added a regression test that checks the committed page stays in sync with the generator and that --check mode catches drift.

Why

The community extensions page was a large manual table and was easy to drift from the catalog source of truth.
Moving the page to generated output keeps the community index aligned with the catalog as entries change.
This reduces maintainer overhead and makes the published list more trustworthy for contributors and users.

Impact

Contributors now update the catalog JSON instead of editing the rendered table by hand.
The community extensions page is more consistent and less likely to go stale.
CI and local tests can detect drift before it lands.

Validation

python scripts/generate_community_extensions_index.py --check
pytest tests/test_community_catalog_docs.py -q

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

This PR introduces an automated generator for the community extensions reference documentation. The generator reads extensions/catalog.community.json and renders a Markdown table into docs/community/extensions.md between sentinel markers, with a CLI supporting --write and --check modes plus tests verifying drift detection.

Changes:

Adds a community_catalog_docs helper module with catalog loading, row iteration, and table/markdown rendering.
Adds a CLI script (scripts/generate_community_extensions_index.py) supporting print/--write/--check modes.
Regenerates docs/community/extensions.md from the catalog, replacing the manually curated table with generated content between sentinel markers; adds tests for sync, sort, and CLI check mode.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 9 comments.

File	Description
src/specify_cli/community_catalog_docs.py	Core helpers to load catalog, iterate rows, and render the generated table/index markdown.
scripts/generate_community_extensions_index.py	CLI entry point wrapping the helpers with write/check/print modes.
docs/community/extensions.md	Replaces the curated table with a generator-driven section delimited by markers; removes Categories/Effect legends.
tests/test_community_catalog_docs.py	Adds tests for sync, alphabetical ordering, and CLI `--check` behavior.

Comments suppressed due to low confidence (1)

scripts/generate_community_extensions_index.py:1

--check and --write are not declared mutually exclusive, and if both are passed --check silently wins (write is skipped). Use parser.add_mutually_exclusive_group() or validate explicitly to make the contract clear.

#!/usr/bin/env python3

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 12 comments.

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (1)

src/specify_cli/workflows/engine.py:1

The explicit guards that rejected bool for type: number (since float(True) becomes 1.0) and enforced real strings for type: string have been removed. This will silently accept common YAML authoring mistakes (e.g. default: true for a number, or default: 5 for a string), potentially producing surprising runtime behavior. Consider reinstating: (1) an explicit isinstance(value, bool) rejection in the number branch, and (2) a string branch that requires isinstance(value, str).

"""Workflow engine — loads, validates, and executes workflow YAML definitions.

mnriem · 2026-05-27T13:05:12Z

Please resolve conflicts

Copilot

Copilot's findings

Files reviewed: 5/5 changed files
Comments generated: 4

mnriem · 2026-05-27T13:52:14Z

Please address Copilot feedback

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

mnriem · 2026-05-28T17:08:50Z

Rebase needed: Please rebase cleanly on upstream/main. The current branch appears to have incorrect conflict resolutions in extensions/catalog.community.json — several entries were silently downgraded (e.g., agent-governance 1.2.0 → 1.0.0, description changes, tool requirement changes). A clean rebase should pick up the current catalog state from main.

Scope: Please revert or split the following changes into a separate PR — they are unrelated to generating the community extensions index:

src/specify_cli/_assets.py — reorders get_speckit_version() priority
src/specify_cli/extensions.py — switches to specifier.contains(current, prereleases=True)
pyproject.toml — adds pythonpath = ["src"]
tests/test_utils_assets_imports.py — adds test_get_speckit_version_prefers_checked_out_pyproject

Copilot feedback: Please address the outstanding Copilot review comments that are not yet outdated.

Communication: Rather than replying individually to each review comment, please use a single comment per commit describing what changed and which feedback items were addressed. This is easier to follow.

AI disclosure: If you are using AI tooling to generate code or review replies, please disclose that. Several replies were posted within a 2-minute window with identical phrasing patterns, which suggests automated generation.

Copilot

Copilot wasn't able to review any files in this pull request.

This reverts commit a180619.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

+        # Escape raw field values *before* composing Markdown syntax so that
+        # a pipe inside a name or description doesn't break a link target.
+        safe_name = _render_cell(row["name"])
+        link = (
+            f"[{safe_name}]({row['repository']})"
+            if row["repository"]
+            else safe_name
+        )


+    cleaned = [f"`{c}`" for tag in tags if (c := str(tag).replace("|", "").strip())]
+    return ", ".join(cleaned) if cleaned else "—"


+                f"`{row['id']}`",
+                _render_cell(row["description"]),
+                _format_tags(row["tags"]),


DyanGalih · 2026-05-28T17:39:52Z

Addressed the prerelease/dev build inconsistency so preset and extension compatibility now both accept source checkouts with prerelease versions when the specifier allows them. I also hardened the community catalog Markdown rendering and added regression tests for the new cases.

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

+        from .community_catalog_docs import render_community_extensions_table
+
+        try:
+            typer.echo(render_community_extensions_table())


+
+
+def _format_inline_code(value: str) -> str:
+    text = _render_cell(value)


+        "--markdown",
+        help=(
+            "Output the full community catalog as a markdown table "
+            "(ignores query/tag/author/verified filters)"


@@ -573,7 +573,7 @@ def check_compatibility(

        try:
            specifier = SpecifierSet(required)


Copilot AI review requested due to automatic review settings May 14, 2026 16:43

DyanGalih changed the title ~~[codex] generate community extensions index from catalog~~ generate community extensions index from catalog May 14, 2026

Copilot AI reviewed May 14, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings May 14, 2026 22:55

Copilot AI reviewed May 14, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings May 14, 2026 23:10

DyanGalih force-pushed the 003-generate-community-docs branch from ea06181 to 0cb36ea Compare May 14, 2026 23:10

Copilot AI reviewed May 14, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings May 26, 2026 22:18

DyanGalih force-pushed the 003-generate-community-docs branch from 7f284f4 to e2ca165 Compare May 26, 2026 22:18

Copilot AI reviewed May 26, 2026

View reviewed changes

DyanGalih force-pushed the 003-generate-community-docs branch from e2ca165 to 8503e48 Compare May 27, 2026 00:13

mnriem requested a review from Copilot May 27, 2026 13:06

Copilot started reviewing on behalf of mnriem May 27, 2026 13:06 View session

Copilot AI reviewed May 27, 2026

View reviewed changes

Comment thread src/specify_cli/__init__.py Outdated

Comment thread tests/test_community_catalog_docs.py

Comment thread extensions/catalog.community.json Outdated

Comment thread extensions/catalog.community.json

DyanGalih added 3 commits May 28, 2026 16:52

feat: generate community extensions index from catalog

ed6fa9d

fix: align version and review replies

98a4e1c

fix: resolve community docs rebase conflicts

2990f8b

Copilot AI review requested due to automatic review settings May 28, 2026 16:55

DyanGalih force-pushed the 003-generate-community-docs branch from b4df9ab to 2990f8b Compare May 28, 2026 16:55

Copilot AI reviewed May 28, 2026

View reviewed changes

Comment thread src/specify_cli/__init__.py

Comment thread src/specify_cli/community_catalog_docs.py

Comment thread src/specify_cli/_assets.py Outdated

Comment thread tests/test_utils_assets_imports.py Outdated

chore: drop unrelated review fixes

623e856

revert: use upstream main versions

a180619

Copilot AI review requested due to automatic review settings May 28, 2026 17:11

Copilot AI reviewed May 28, 2026

View reviewed changes

DyanGalih added 2 commits May 28, 2026 17:13

Revert "revert: use upstream main versions"

6830d32

This reverts commit a180619.

chore: keep main versions for generated docs

bc78f5d

Copilot AI review requested due to automatic review settings May 28, 2026 17:18

feat: restore community markdown hook

45ac3d7

Copilot AI reviewed May 28, 2026

View reviewed changes

fix: align prerelease and docs rendering behavior

bf1a220

DyanGalih marked this pull request as ready for review May 28, 2026 17:41

DyanGalih requested a review from mnriem as a code owner May 28, 2026 17:41

Copilot AI review requested due to automatic review settings May 28, 2026 17:41

Copilot AI reviewed May 28, 2026

View reviewed changes

		cleaned = [f"`{c}`" for tag in tags if (c := str(tag).replace("\|", "").strip())]
		return ", ".join(cleaned) if cleaned else "—"



		def _format_inline_code(value: str) -> str:
		text = _render_cell(value)

		@@ -573,7 +573,7 @@ def check_compatibility(

		try:
		specifier = SpecifierSet(required)

Conversation

DyanGalih commented May 14, 2026

What changed

Why

Impact

Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnriem commented May 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnriem commented May 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!