fix(workflows): auto-detect project integration instead of hardcoding copilot default by markuswondrak · Pull Request #2408 · github/spec-kit

markuswondrak · 2026-04-29T13:30:32Z

Description

The built-in speckit workflow used "copilot" as the default integration input. In projects initialized with a different integration such as opencode, workflows could dispatch to the wrong agent and fail with "No such agent: speckit.specify" when the copilot CLI happened to be installed locally.

Changes

workflows/speckit/workflow.yml
- Changed the integration input default from "copilot" to "auto"
- Updated the prompt examples to include opencode and the explicit auto option
- Removed the stale static requires.integrations.any allowlist
src/specify_cli/workflows/engine.py
- Added _resolve_default() and _load_project_integration() to read .specify/integration.json
- Preserved the "copilot" fallback for missing, unreadable, invalid, or empty config
- Added post-processing in _resolve_inputs() so both defaulted and explicit --input integration=auto values resolve through the same path
tests/test_workflows.py
- Added 7 regression tests covering default auto-detection, explicit integration=auto, explicit override precedence, missing file fallback, invalid JSON fallback, OSError fallback, and whitespace-only values

How it works

The workflow YAML now defaults integration to "auto"
When the resolved integration value is "auto", the engine reads .specify/integration.json and uses the stored integration key
If the file is missing, unreadable, invalid, or does not contain a usable integration value, the engine falls back to "copilot" for backwards compatibility

Testing

uvx ruff check src/ tests/test_workflows.py
uv run pytest tests/test_workflows.py
uv run pytest tests/test_workflows.py -k TestIntegrationAutoDetect -v

AI Disclosure

I did use AI assistance (describe below)

This PR was authored with GitHub Copilot CLI assistance. All changes were reviewed and verified by the contributor.

… copilot (github#2406) The workflow engine hardcoded 'copilot' as the default integration input, ignoring the project's configured integration in .specify/integration.json. This caused workflows to fail when a project was initialized with a different integration (e.g. opencode) but the copilot CLI happened to be installed. Changes: - Change workflow.yml integration default from 'copilot' to 'auto' - Add _resolve_integration_auto() to WorkflowEngine that reads .specify/integration.json and falls back to 'copilot' if absent - Post-process resolved inputs to replace 'auto' with detected value - Add 4 regression tests for auto-detection scenarios Fixes github#2406 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Updates the built-in speckit workflow and workflow engine to avoid hardcoding "copilot" as the default integration by introducing an "auto" integration mode that resolves from project configuration.

Changes:

Set workflows/speckit/workflow.yml integration input default to "auto" and updated the prompt to document it.
Added WorkflowEngine._resolve_integration_auto() and post-processing in _resolve_inputs() to read .specify/integration.json, with fallback to "copilot".
Added regression tests for auto-detection, fallback behavior, explicit override precedence, and empty JSON handling; added an Unreleased changelog entry.

Reviewed changes

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

File	Description
workflows/speckit/workflow.yml	Switches workflow input default integration from `"copilot"` to `"auto"` so runs honor project configuration.
src/specify_cli/workflows/engine.py	Implements `"auto"` integration resolution by reading `.specify/integration.json` with a backward-compatible fallback.
tests/test_workflows.py	Adds regression tests to ensure `"auto"` resolves correctly and preserves override behavior.
CHANGELOG.md	Notes the fix in the Unreleased section.

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

mnriem

Thank you for looking into this. Please address Copilot feedback. If not applicable, please explain why

…thub#2408) Made-with: Cursor

Copilot

Pull request overview

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

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

…uto-detect

Copilot

Copilot's findings

Tip

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

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

mnriem

Please address Copilot feedback

- Add tests for JSONDecodeError and OSError fallback paths in _resolve_integration_auto() - Centralize INTEGRATION_JSON constant in workflows/constants.py (zero-dependency module) - Change changelog reference to (Fixes github#2406) for auto-close semantics - Remove static requires.integrations.any from speckit workflow (incomplete with 'auto') - Add opencode to integration prompt examples

markuswondrak · 2026-04-29T16:46:36Z

Thanks for the thorough review! I've addressed all four findings:

Missing test coverage — Added two new tests for JSONDecodeError and OSError fallback paths in _resolve_integration_auto().
Duplicated constant — Centralized INTEGRATION_JSON into src/specify_cli/workflows/constants.py (zero-dependency module) and imported from both engine.py and __init__.py.
Changelog reference — Changed (#2406) to (Fixes #2406) for auto-close semantics.
Workflow metadata — Removed requires.integrations.any from workflow.yml. Since "auto" resolves the integration dynamically from the project's integration.json, a static allowlist is inherently incomplete — every new integration added to the registry would require updating this workflow file, creating clutter and a maintenance burden. The requires field is also not enforced at runtime currently (engine.py line 50-52: "declared but not yet enforced at runtime; enforcement is a planned enhancement"). If/when enforcement is added, it should validate against the runtime INTEGRATION_REGISTRY rather than a hardcoded list.

Is removing the integrations key entirely acceptable, or would you prefer to keep it as documentation with the full list of all 26 integrations?

mnriem

Please resolve conflicts

Copilot

Copilot's findings

Tip

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

Files reviewed: 5/6 changed files
Comments generated: 3

mnriem · 2026-04-29T22:22:05Z

Please revert changes to CHANGELOG.md as it is now auto-generated (still need to update docs to no longer require it) and resolve the other conflict

- CHANGELOG.md: take released [0.8.3] block from origin, discard auto-generated [Unreleased] section that shouldn't have been committed - __init__.py: add devin_skill_mode from origin, preserve multi-line native_skill_mode format from HEAD Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- engine.py: strip whitespace from integration value in _resolve_integration_auto(); whitespace-only strings like ' ' now fall back to 'copilot' instead of being returned as-is - __init__.py: define INTEGRATION_JSON locally instead of importing from workflows.constants; avoids executing the workflows package __init__ (which registers all step types) during CLI startup for commands that don't use workflows - tests: add test for whitespace-only integration value fallback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

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

Move INTEGRATION_JSON from specify_cli.workflows.constants to specify_cli.constants to avoid importing the workflows package when the main CLI module loads. Update imports in __init__.py and workflows/engine.py accordingly, and remove the now-empty workflows/constants.py. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated no new comments.

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

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 1 comment.

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

Copilot

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated no new comments.

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

… config - Add _INTEGRATION_JSON local constant in engine.py - Replace post-processing _resolve_integration_auto() with inline _resolve_default() + _load_project_integration() methods - Revert all Black style-only changes to engine.py, __init__.py - Delete unnecessary constants.py - Add TestIntegrationAutoDetect with 6 tests (no changes to existing tests) - Update workflow.yml: default 'auto', remove static integrations.any list Agent-Logs-Url: https://github.com/markuswondrak/spec-kit/sessions/4cb75741-9272-4a13-a90b-cc6cad486967 Co-authored-by: markuswondrak <245696895+markuswondrak@users.noreply.github.com>

…ion-auto-detect fix(workflows): minimal-invasive auto-detect integration from project config

Copilot

Pull request overview

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

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

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

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

Use suggested type-safe strip call Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

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

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

Copilot

Copilot's findings

Tip

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

Comments suppressed due to low confidence (1)

src/specify_cli/workflows/engine.py:747

The docstring says the method falls back when the file “does not contain a valid” key, but the implementation only checks for a non-empty string (and not a known integration key). Either validate the value against the registered integrations (and fall back if unknown) or adjust the docstring wording to match the current behavior.

    def _load_project_integration(self) -> str:
        """Read the active integration key from ``.specify/integration.json``.

        Returns the stored integration string, or ``"copilot"`` when the file is
        missing, unreadable, or does not contain a valid non-empty key.
        The ``"copilot"`` fallback preserves backwards compatibility for projects
        that predate the introduction of ``.specify/integration.json``.
        """

Files reviewed: 3/3 changed files
Comments generated: 2

Copilot · 2026-05-01T13:45:17Z

+        recorded in ``.specify/integration.json`` so workflows dispatch to the
+        AI the project was actually initialized with.
+        """
+        if name == "integration" and default == "auto":
+            return self._load_project_integration()
+        return default
+
+    def _load_project_integration(self) -> str:
+        """Read the active integration key from ``.specify/integration.json``.
+
+        Returns the stored integration string, or ``"copilot"`` when the file is
+        missing, unreadable, or does not contain a valid non-empty key.
+        The ``"copilot"`` fallback preserves backwards compatibility for projects
+        that predate the introduction of ``.specify/integration.json``.
+        """
+        path = self.project_root / _INTEGRATION_JSON
+        if not path.is_file():
+            return "copilot"
+        try:
+            data = json.loads(path.read_text(encoding="utf-8"))
+        except (OSError, UnicodeDecodeError, json.JSONDecodeError):
+            return "copilot"
+        if isinstance(data, dict):
+            value = data.get("integration")
+            if isinstance(value, str):
+                value = value.strip()
+                if value and value != "auto":
+                    return value


_load_project_integration() only consults .specify/integration.json. If that file is missing but .specify/init-options.json still exists (e.g., older projects or users deleting integration.json), integration=auto will incorrectly fall back to copilot instead of the project’s configured integration. Consider adding a secondary lookup (read init-options.json’s integration/ai key) before falling back to copilot.

This issue also appears on line 740 of the same file.

Suggested change

recorded in ``.specify/integration.json`` so workflows dispatch to the

AI the project was actually initialized with.

"""

if name == "integration" and default == "auto":

return self._load_project_integration()

return default

def _load_project_integration(self) -> str:

"""Read the active integration key from ``.specify/integration.json``.

Returns the stored integration string, or ``"copilot"`` when the file is

missing, unreadable, or does not contain a valid non-empty key.

The ``"copilot"`` fallback preserves backwards compatibility for projects

that predate the introduction of ``.specify/integration.json``.

"""

path = self.project_root / _INTEGRATION_JSON

if not path.is_file():

return "copilot"

try:

data = json.loads(path.read_text(encoding="utf-8"))

except (OSError, UnicodeDecodeError, json.JSONDecodeError):

return "copilot"

if isinstance(data, dict):

value = data.get("integration")

if isinstance(value, str):

value = value.strip()

if value and value != "auto":

return value

recorded in project metadata so workflows dispatch to the AI the project

was actually initialized with.

"""

if name == "integration" and default == "auto":

return self._load_project_integration()

return default

def _load_project_integration(self) -> str:

"""Read the active integration key from project metadata.

The primary source is ``.specify/integration.json``. If that file is

missing or invalid, fall back to ``.specify/init-options.json`` for

older projects or partially migrated state, checking ``integration``

first and then ``ai``. Returns ``"copilot"`` only when neither source

contains a valid non-empty integration key.

"""

def _read_integration(path: Path, *keys: str) -> str | None:

if not path.is_file():

return None

try:

data = json.loads(path.read_text(encoding="utf-8"))

except (OSError, UnicodeDecodeError, json.JSONDecodeError):

return None

if not isinstance(data, dict):

return None

for key in keys:

value = data.get(key)

if isinstance(value, str):

value = value.strip()

if value and value != "auto":

return value

return None

integration = _read_integration(

self.project_root / _INTEGRATION_JSON, "integration"

)

if integration is not None:

return integration

integration = _read_integration(

self.project_root / ".specify" / "init-options.json",

"integration",

"ai",

)

if integration is not None:

return integration

Copilot · 2026-05-01T13:45:17Z

 # ID format: lowercase alphanumeric with hyphens
 _ID_PATTERN = re.compile(r"^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$")

+_INTEGRATION_JSON = ".specify/integration.json"


_INTEGRATION_JSON duplicates the existing INTEGRATION_JSON = ".specify/integration.json" constant in src/specify_cli/__init__.py. To avoid string drift, consider centralizing this path constant in a small shared module (e.g., specify_cli/paths.py) and importing it from both places (avoiding importing the CLI module here).

Suggested change

_INTEGRATION_JSON = ".specify/integration.json"

_SPECIFY_DIR = ".specify"

_INTEGRATION_JSON_FILENAME = "integration.json"

_INTEGRATION_JSON = f"{_SPECIFY_DIR}/{_INTEGRATION_JSON_FILENAME}"

mnriem

Please address Copilot feedback. If not applicable, please explain why

Copilot AI review requested due to automatic review settings April 29, 2026 13:30

markuswondrak requested a review from mnriem as a code owner April 29, 2026 13:30

Copilot started reviewing on behalf of markuswondrak April 29, 2026 13:31 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py Outdated

Comment thread tests/test_workflows.py Outdated

mnriem requested changes Apr 29, 2026

View reviewed changes

fix(workflows): tolerate non-UTF8 integration.json in auto-detect (gi…

903ce05

…thub#2408) Made-with: Cursor

Copilot AI review requested due to automatic review settings April 29, 2026 14:13

Copilot started reviewing on behalf of markuswondrak April 29, 2026 14:13 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

markuswondrak requested a review from mnriem April 29, 2026 14:40

Merge remote-tracking branch 'origin' into fix/workflow-integration-a…

cd8b207

…uto-detect

mnriem requested a review from Copilot April 29, 2026 14:55

Copilot started reviewing on behalf of mnriem April 29, 2026 14:55 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py Outdated

Comment thread src/specify_cli/workflows/engine.py Outdated

Comment thread CHANGELOG.md Outdated

Comment thread workflows/speckit/workflow.yml Outdated

mnriem requested changes Apr 29, 2026

View reviewed changes

markuswondrak requested a review from mnriem April 29, 2026 17:19

mnriem requested changes Apr 29, 2026

View reviewed changes

mnriem requested a review from Copilot April 29, 2026 21:24

Copilot started reviewing on behalf of mnriem April 29, 2026 21:24 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py Outdated

Comment thread src/specify_cli/__init__.py Outdated

Comment thread tests/test_workflows.py

Markus and others added 2 commits April 30, 2026 07:08

markuswondrak requested a review from Copilot April 30, 2026 05:14

Copilot started reviewing on behalf of markuswondrak April 30, 2026 05:14 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/constants.py Outdated

markuswondrak requested review from Copilot and mnriem April 30, 2026 06:33

Copilot started reviewing on behalf of markuswondrak April 30, 2026 06:34 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

markuswondrak requested a review from Copilot April 30, 2026 06:40

Copilot started reviewing on behalf of markuswondrak April 30, 2026 06:41 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py Outdated

markuswondrak requested a review from Copilot April 30, 2026 06:49

Copilot started reviewing on behalf of markuswondrak April 30, 2026 06:50 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Initial plan

609eade

Copilot AI mentioned this pull request Apr 30, 2026

fix(workflows): minimal-invasive auto-detect integration from project config markuswondrak/spec-kit#1

Merged

Copilot AI and others added 2 commits April 30, 2026 14:53

Merge pull request #1 from markuswondrak/copilot/fixworkflow-integrat…

6727c14

…ion-auto-detect fix(workflows): minimal-invasive auto-detect integration from project config

markuswondrak requested a review from Copilot April 30, 2026 15:01

Copilot started reviewing on behalf of markuswondrak April 30, 2026 15:01 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py

Comment thread src/specify_cli/workflows/engine.py Outdated

Comment thread tests/test_workflows.py

fix(workflows): resolve explicit integration auto input

a811a78

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

markuswondrak requested a review from Copilot April 30, 2026 19:01

Copilot started reviewing on behalf of markuswondrak April 30, 2026 19:02 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Comment thread src/specify_cli/workflows/engine.py Outdated

Update src/specify_cli/workflows/engine.py

98afd4a

Use suggested type-safe strip call Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 30, 2026 19:11

Copilot started reviewing on behalf of markuswondrak April 30, 2026 19:11 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

mnriem requested a review from Copilot May 1, 2026 13:40

Copilot started reviewing on behalf of mnriem May 1, 2026 13:41 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

mnriem requested changes May 1, 2026

View reviewed changes

Copilot AI mentioned this pull request May 1, 2026

fix(workflows): centralize path constants and add init-options.json fallback for auto-detect markuswondrak/spec-kit#2

Draft

-_INTEGRATION_JSON = ".specify/integration.json"
+_SPECIFY_DIR = ".specify"
+_INTEGRATION_JSON_FILENAME = "integration.json"
+_INTEGRATION_JSON = f"{_SPECIFY_DIR}/{_INTEGRATION_JSON_FILENAME}"

Conversation

markuswondrak commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

How it works

Testing

AI Disclosure

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!

mnriem left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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 left a comment

Choose a reason for hiding this comment

Uh oh!

markuswondrak commented Apr 29, 2026

Uh oh!

mnriem left a comment

Choose a reason for hiding this comment

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!

mnriem commented Apr 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

markuswondrak commented Apr 29, 2026 •

edited

Loading