💫 Toolkit to help you get started with SDD or any other process!
docs: move extension API reference into documentation (#5174)
Manfred Riemd605a15b1926
diff --git a/bundles/bugfix/bundle.yml b/bundles/bugfix/bundle.ymlindex 3e1c835e9..87a92a3d1 100644--- a/bundles/bugfix/bundle.yml+++ b/bundles/bugfix/bundle.yml@@ -3,7 +3,7 @@ schema_version: "1.0"bundle:id: "bugfix"name: "Guided Bug Fix"- version: "1.0.1"+ version: "1.0.2"role: "developer"description: "Orchestrated bug triage: assess a bug report, review the assessment behind a human gate, apply the fix, and verify it with tests."author: "GitHub"@@ -17,7 +17,7 @@ requires:provides:extensions:- id: "bug"- version: "1.0.1"+ version: "1.0.2"workflows:- id: "bugfix"version: "1.0.0"diff --git a/bundles/catalog.json b/bundles/catalog.jsonindex b66acef87..6d2e70d16 100644--- a/bundles/catalog.json+++ b/bundles/catalog.json@@ -6,7 +6,7 @@"bugfix": {"id": "bugfix","name": "Guided Bug Fix",- "version": "1.0.1",+ "version": "1.0.2","role": "developer","description": "Orchestrated bug triage: assess a bug report, review behind a human gate, apply the fix, and verify with tests.","author": "GitHub",diff --git a/extensions/EXTENSION-API-REFERENCE.md b/docs/extensions/api.mdsimilarity index 100%rename from extensions/EXTENSION-API-REFERENCE.mdrename to docs/extensions/api.mddiff --git a/docs/toc.yml b/docs/toc.ymlindex e71b0ad5f..c1f11b3cc 100644--- a/docs/toc.yml+++ b/docs/toc.yml@@ -143,6 +143,8 @@href: extensions/overview.md- name: Developinghref: extensions/developing.md+ - name: API Reference+ href: extensions/api.md- name: Publishinghref: extensions/publishing.mddiff --git a/extensions/bug/README.md b/extensions/bug/README.mdindex 447cb8277..363ff363b 100644--- a/extensions/bug/README.md+++ b/extensions/bug/README.md@@ -99,4 +99,4 @@ hooks:description: Collect evidence in the resolved bug directory```-Mandatory hooks are invoked and awaited; optional hooks are presented for the user to run. Disabled hooks and hooks with non-empty conditions are skipped by the command templates. With no registered hooks, the workflow proceeds as before. See the [Extension API Reference](../EXTENSION-API-REFERENCE.md#hook-events) for the shared hook contract.+Mandatory hooks are invoked and awaited; optional hooks are presented for the user to run. Disabled hooks and hooks with non-empty conditions are skipped by the command templates. With no registered hooks, the workflow proceeds as before. See the [Extension API Reference](https://github.github.io/spec-kit/extensions/api.html#hook-events) for the shared hook contract.diff --git a/extensions/bug/extension.yml b/extensions/bug/extension.ymlindex 17f14809e..75a9e45a2 100644--- a/extensions/bug/extension.yml+++ b/extensions/bug/extension.yml@@ -3,7 +3,7 @@ schema_version: "1.0"extension:id: bugname: "Bug Triage Workflow"- version: "1.0.1"+ version: "1.0.2"description: "Assess, fix, and validate bug reports against the codebase with per-bug reports stored under .specify/bugs/<slug>/"author: spec-kit-corerepository: https://github.com/github/spec-kitdiff --git a/extensions/catalog.json b/extensions/catalog.jsonindex 5bd7235b8..fed3f0884 100644--- a/extensions/catalog.json+++ b/extensions/catalog.json@@ -36,7 +36,7 @@"bug": {"name": "Bug Triage Workflow","id": "bug",- "version": "1.0.1",+ "version": "1.0.2","description": "Assess, fix, and validate bug reports against the codebase with per-bug reports stored under .specify/bugs/<slug>/","author": "spec-kit-core","repository": "https://github.com/github/spec-kit",@@ -66,7 +66,7 @@"github": {"name": "GitHub Integration","id": "github",- "version": "1.0.3",+ "version": "1.0.4","description": "GitHub platform integration for Spec Kit - create GitHub issues from a feature's task list","author": "spec-kit-core","repository": "https://github.com/github/spec-kit",diff --git a/extensions/github/README.md b/extensions/github/README.mdindex 6ee2100ac..95e239618 100644--- a/extensions/github/README.md+++ b/extensions/github/README.md@@ -130,7 +130,7 @@ If an extension proposal or external dependency declaration uses`speckit.github.taskstoissues`. `requires.commands` is not an enforced dependencyfield in the current extension manifest API, so do not rely on that declarationto install or check the GitHub extension. Follow the supported requirements in-the [extension API reference](../EXTENSION-API-REFERENCE.md#extension-manifest).+the [extension API reference](https://github.github.io/spec-kit/extensions/api.html#extension-manifest).Preset command overrides are separate from command references: an override of`speckit.taskstoissues` does not automatically customize the namespaced GitHubdiff --git a/extensions/github/extension.yml b/extensions/github/extension.ymlindex 158824e82..e8305c39b 100644--- a/extensions/github/extension.yml+++ b/extensions/github/extension.yml@@ -3,7 +3,7 @@ schema_version: "1.0"extension:id: githubname: "GitHub Integration"- version: "1.0.3"+ version: "1.0.4"description: "GitHub platform integration for Spec Kit - create GitHub issues from a feature's task list"author: spec-kit-corerepository: https://github.com/github/spec-kitdiff --git a/extensions/template/README.md b/extensions/template/README.mdindex 899591580..657e2ef8a 100644--- a/extensions/template/README.md+++ b/extensions/template/README.md@@ -68,7 +68,7 @@ Starter template for creating a Spec Kit extension.## Need Help?- **Development Guide**: See [Extension Development Guide](https://github.github.io/spec-kit/extensions/developing.html)-- **API Reference**: See EXTENSION-API-REFERENCE.md+- **API Reference**: See the [Extension API Reference](https://github.github.io/spec-kit/extensions/api.html)- **Publishing Guide**: See the [Extension Publishing Guide](https://github.github.com/spec-kit/extensions/publishing.html)- **User Guide**: See the [Extension User Guide](https://github.github.io/spec-kit/extensions/overview.html)diff --git a/tests/extensions/bug/test_bug_hooks.py b/tests/extensions/bug/test_bug_hooks.pyindex 703162143..7356959fe 100644--- a/tests/extensions/bug/test_bug_hooks.py+++ b/tests/extensions/bug/test_bug_hooks.py@@ -81,7 +81,7 @@ def test_assess_ensures_bug_directory_before_hook_checks():@pytest.mark.parametrize("path", [- ROOT / "extensions/EXTENSION-API-REFERENCE.md",+ ROOT / "docs/extensions/api.md",ROOT / "docs/extensions/developing.md",ROOT / "docs/extensions/overview.md",EXT_DIR / "README.md",diff --git a/tests/extensions/github/test_github_extension.py b/tests/extensions/github/test_github_extension.pyindex 5b8adc504..8de187999 100644--- a/tests/extensions/github/test_github_extension.py+++ b/tests/extensions/github/test_github_extension.py@@ -158,7 +158,7 @@ class TestManifest:m = ExtensionManifest(EXT_DIR / "extension.yml")assert m.id == "github"- assert m.version == "1.0.3"+ assert m.version == "1.0.4"assert [c["name"] for c in m.commands] == [COMMAND_NAME]def test_manifest_command_files_exist(self):diff --git a/tests/test_extensions.py b/tests/test_extensions.pyindex 13350e2ac..ed4353ce5 100644--- a/tests/test_extensions.py+++ b/tests/test_extensions.py@@ -8777,7 +8777,7 @@ class TestConfigManagerNonMappingManifestConfigSection:class TestConfigManagerTopLevelManifestDefaults:"""A top-level `defaults:` in extension.yml must be loaded (#5084).- The extension template and EXTENSION-API-REFERENCE.md put defaults under a+ The extension template and docs/extensions/api.md put defaults under atop-level ``defaults:`` key, but ``_get_extension_defaults`` only read``config.defaults``, so an extension built from the template silently hadno defaults at runtime.