mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 20:36:23 +08:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
f16468f21f |
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -1,3 +1 @@
|
||||
* text=auto eol=lf
|
||||
|
||||
.github/workflows/*.lock.yml linguist-generated=true merge=ours -whitespace
|
||||
14
.github/aw/actions-lock.json
vendored
14
.github/aw/actions-lock.json
vendored
@@ -1,14 +0,0 @@
|
||||
{
|
||||
"entries": {
|
||||
"actions/github-script@v9.0.0": {
|
||||
"repo": "actions/github-script",
|
||||
"version": "v9.0.0",
|
||||
"sha": "3a2844b7e9c422d3c10d287c895573f7108da1b3"
|
||||
},
|
||||
"github/gh-aw-actions/setup@v0.74.8": {
|
||||
"repo": "github/gh-aw-actions/setup",
|
||||
"version": "v0.74.8",
|
||||
"sha": "efa55847f72aadb03490d955263ff911bf758700"
|
||||
}
|
||||
}
|
||||
}
|
||||
21
.github/dependabot.yml
vendored
21
.github/dependabot.yml
vendored
@@ -1,12 +1,11 @@
|
||||
updates:
|
||||
- directory: /
|
||||
package-ecosystem: pip
|
||||
schedule:
|
||||
interval: weekly
|
||||
- directory: /
|
||||
ignore:
|
||||
- dependency-name: "github/gh-aw-actions/**" # Managed by gh aw compile. Version-locked to the gh-aw compiler; do not bump.
|
||||
package-ecosystem: github-actions
|
||||
schedule:
|
||||
interval: weekly
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "pip"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
|
||||
1579
.github/workflows/add-community-extension.lock.yml
vendored
1579
.github/workflows/add-community-extension.lock.yml
vendored
File diff suppressed because it is too large
Load Diff
288
.github/workflows/add-community-extension.md
vendored
288
.github/workflows/add-community-extension.md
vendored
@@ -1,288 +0,0 @@
|
||||
---
|
||||
description: "Process community extension submission issues — validate, add to catalog, and open a PR for maintainer review"
|
||||
emoji: "🧩"
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened, edited, labeled]
|
||||
skip-bots: [github-actions, copilot, dependabot]
|
||||
|
||||
tools:
|
||||
edit:
|
||||
bash: ["echo", "cat", "head", "tail", "grep", "wc", "sort", "python3", "jq", "date"]
|
||||
github:
|
||||
toolsets: [issues, repos]
|
||||
web-fetch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: read
|
||||
|
||||
checkout:
|
||||
fetch-depth: 0
|
||||
|
||||
safe-outputs:
|
||||
create-pull-request:
|
||||
title-prefix: "[extension] "
|
||||
labels: [extension-submission, automated]
|
||||
draft: true
|
||||
max: 1
|
||||
protected-files:
|
||||
policy: blocked
|
||||
exclude:
|
||||
- README.md
|
||||
- CHANGELOG.md
|
||||
add-comment:
|
||||
max: 2
|
||||
add-labels:
|
||||
allowed: [extension-submission, validation-passed, validation-failed, needs-info]
|
||||
max: 3
|
||||
---
|
||||
|
||||
# Add Community Extension from Issue Submission
|
||||
|
||||
You are a catalog maintenance agent for the Spec Kit project. Your job is to
|
||||
process community extension submission issues and create pull requests that add
|
||||
or update entries in the community extension catalog.
|
||||
|
||||
## Triggering Conditions
|
||||
|
||||
This workflow triggers on issue events. **Only process the issue if ALL of these
|
||||
conditions are met:**
|
||||
|
||||
1. The issue has the `extension-submission` label
|
||||
2. The issue title starts with `[Extension]:`
|
||||
|
||||
If the issue does not meet these conditions, add a brief comment explaining that
|
||||
this workflow only processes extension submission issues, then stop.
|
||||
|
||||
## Step 1 — Read and Parse the Issue
|
||||
|
||||
Read issue #${{ github.event.issue.number }}.
|
||||
|
||||
Extract the following fields from the structured issue body (GitHub issue form
|
||||
fields):
|
||||
|
||||
| Field | Issue Form ID | Required |
|
||||
|-------|--------------|----------|
|
||||
| Extension ID | `extension-id` | Yes |
|
||||
| Extension Name | `extension-name` | Yes |
|
||||
| Version | `version` | Yes |
|
||||
| Description | `description` | Yes |
|
||||
| Author | `author` | Yes |
|
||||
| Repository URL | `repository` | Yes |
|
||||
| Download URL | `download-url` | Yes |
|
||||
| License | `license` | Yes |
|
||||
| Homepage | `homepage` | No |
|
||||
| Documentation URL | `documentation` | No |
|
||||
| Changelog URL | `changelog` | No |
|
||||
| Required Spec Kit Version | `speckit-version` | Yes |
|
||||
| Required Tools | `required-tools` | No |
|
||||
| Number of Commands | `commands-count` | Yes |
|
||||
| Number of Hooks | `hooks-count` | No (default 0) |
|
||||
| Tags | `tags` | Yes |
|
||||
| Proposed Catalog Entry | `catalog-entry` | Yes |
|
||||
|
||||
The issue body uses GitHub's issue form format. Each field appears under a
|
||||
heading matching the field label (e.g., `### Extension ID` followed by the
|
||||
value). Parse accordingly.
|
||||
|
||||
## Step 2 — Validate the Submission
|
||||
|
||||
Run **all** of the following validation checks. Collect all results before
|
||||
deciding pass/fail:
|
||||
|
||||
### 2a. Extension ID format
|
||||
- Must match regex: `^[a-z][a-z0-9-]*$`
|
||||
- Must be lowercase with hyphens only
|
||||
|
||||
### 2b. Version format
|
||||
- Must follow semver: `X.Y.Z` (digits only, no `v` prefix)
|
||||
|
||||
### 2c. Repository validation
|
||||
- Fetch the repository URL — confirm it exists and is publicly accessible
|
||||
- Confirm the repository contains an `extension.yml` file
|
||||
- Confirm the repository contains a `README.md` file
|
||||
- Confirm the repository contains a `LICENSE` file
|
||||
|
||||
### 2d. Release and download URL validation
|
||||
- The download URL should follow the pattern
|
||||
`https://github.com/<owner>/<repo>/archive/refs/tags/v<version>.zip`
|
||||
or
|
||||
`https://github.com/<owner>/<repo>/releases/download/<tag>/<asset>.zip`
|
||||
- Verify a GitHub release exists matching the submitted version
|
||||
|
||||
### 2e. Submission checklists
|
||||
- Confirm that all required checkboxes in the Testing Checklist and Submission
|
||||
Requirements sections are checked (`[x]`)
|
||||
|
||||
### Validation outcome
|
||||
|
||||
If **any** validation fails:
|
||||
1. Add a comment on the issue listing each failed check with a clear explanation
|
||||
of what's wrong and how to fix it
|
||||
2. Add the `validation-failed` label
|
||||
3. **Stop — do not proceed further**
|
||||
|
||||
If all validations pass:
|
||||
1. Add the `validation-passed` label
|
||||
2. Continue to Step 3
|
||||
|
||||
## Step 3 — Determine Add vs Update
|
||||
|
||||
Search `extensions/catalog.community.json` for the extension ID.
|
||||
|
||||
- **Not found** → this is a **new addition**
|
||||
- **Found** → this is an **update** — replace the existing entry in-place;
|
||||
preserve `created_at`, `downloads`, and `stars` from the existing entry
|
||||
|
||||
## Step 4 — Update `extensions/catalog.community.json`
|
||||
|
||||
Edit `extensions/catalog.community.json` to add or update the extension entry.
|
||||
|
||||
### For a new extension
|
||||
|
||||
Insert the entry in **alphabetical order by extension ID** within the
|
||||
`"extensions"` object. Use this structure:
|
||||
|
||||
```json
|
||||
{
|
||||
"<id>": {
|
||||
"name": "<name>",
|
||||
"id": "<id>",
|
||||
"description": "<description>",
|
||||
"author": "<author>",
|
||||
"version": "<version>",
|
||||
"download_url": "<download_url>",
|
||||
"repository": "<repository>",
|
||||
"homepage": "<homepage or repository>",
|
||||
"documentation": "<documentation or repository README>",
|
||||
"changelog": "<changelog or empty string>",
|
||||
"license": "<license>",
|
||||
"requires": {
|
||||
"speckit_version": "<speckit_version>"
|
||||
},
|
||||
"provides": {
|
||||
"commands": <N>,
|
||||
"hooks": <N>
|
||||
},
|
||||
"tags": ["<tag1>", "<tag2>"],
|
||||
"verified": false,
|
||||
"downloads": 0,
|
||||
"stars": 0,
|
||||
"created_at": "<today>T00:00:00Z",
|
||||
"updated_at": "<today>T00:00:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
If the extension has optional tool dependencies, add a `"tools"` array inside
|
||||
`"requires"`:
|
||||
|
||||
```json
|
||||
"tools": [{ "name": "<tool>", "required": false }]
|
||||
```
|
||||
|
||||
### For an update
|
||||
|
||||
Replace only the changed fields (typically `version`, `download_url`,
|
||||
`description`, `provides`, `requires`, `tags`, `updated_at`). **Preserve**
|
||||
`created_at`, `downloads`, and `stars` from the existing entry.
|
||||
|
||||
### After editing
|
||||
|
||||
Update the **top-level `"updated_at"` timestamp** in the catalog to today's date
|
||||
in ISO 8601 format.
|
||||
|
||||
Validate the JSON by running:
|
||||
|
||||
```bash
|
||||
python3 -c "import json; json.load(open('extensions/catalog.community.json')); print('Valid JSON')"
|
||||
```
|
||||
|
||||
If validation fails, fix the JSON and re-validate before continuing.
|
||||
|
||||
## Step 5 — Update `docs/community/extensions.md`
|
||||
|
||||
Edit `docs/community/extensions.md` to add or update a row in the Community
|
||||
Extensions table.
|
||||
|
||||
### For a new extension
|
||||
|
||||
Insert a new row in **alphabetical order by extension name**:
|
||||
|
||||
```
|
||||
| <Name> | <Description> | `<category>` | <Effect> | [<repo-name>](<repository-url>) |
|
||||
```
|
||||
|
||||
Determine the category from the extension's behavior:
|
||||
- `docs` — reads, validates, or generates spec artifacts
|
||||
- `code` — reviews, validates, or modifies source code
|
||||
- `process` — orchestrates workflow across phases
|
||||
- `integration` — syncs with external platforms
|
||||
- `visibility` — reports on project health or progress
|
||||
|
||||
Determine the effect:
|
||||
- `Read-only` — produces reports only
|
||||
- `Read+Write` — modifies project files
|
||||
|
||||
### For an update
|
||||
|
||||
Find the existing row and update any changed fields in-place.
|
||||
|
||||
## Step 6 — Create Pull Request
|
||||
|
||||
Create a pull request with the changes. Use this branch naming convention:
|
||||
|
||||
- **New extension:** `add-<extension-id>-extension`
|
||||
- **Update:** `update-<extension-id>-extension`
|
||||
|
||||
### Commit message
|
||||
|
||||
For a new extension:
|
||||
```
|
||||
Add <Name> extension to community catalog
|
||||
|
||||
Add <id> extension submitted by @<issue-author> to:
|
||||
- extensions/catalog.community.json (alphabetical order)
|
||||
- docs/community/extensions.md community extensions table
|
||||
|
||||
Closes #<issue-number>
|
||||
```
|
||||
|
||||
For an update:
|
||||
```
|
||||
Update <Name> extension to v<version>
|
||||
|
||||
Update <id> extension submitted by @<issue-author>:
|
||||
- extensions/catalog.community.json (version, download_url, etc.)
|
||||
- docs/community/extensions.md community extensions table
|
||||
|
||||
Closes #<issue-number>
|
||||
```
|
||||
|
||||
### PR description
|
||||
|
||||
Include:
|
||||
- A summary of what changed
|
||||
- Validation results (all checks passed)
|
||||
- `Closes #${{ github.event.issue.number }}`
|
||||
- `cc @<issue-author>` — mention the submitter
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Alphabetical order matters** — entries must be sorted by ID in the JSON and
|
||||
by name in the docs table
|
||||
- **Always validate JSON** after editing — a trailing comma or missing brace
|
||||
will break the catalog
|
||||
- **Use `Closes` not `Fixes`** — `Closes #N` is the correct keyword for
|
||||
submission issues
|
||||
- **Match the proposed entry but verify** — the issue may include a proposed
|
||||
JSON block, but always validate field values against the actual repository
|
||||
state rather than blindly trusting the submitter's JSON
|
||||
- **Preserve `created_at` on updates** — keep the original value; only update
|
||||
`updated_at`
|
||||
- **Preserve `downloads` and `stars` on updates** — these reflect usage metrics
|
||||
and must not be reset
|
||||
- **Do not modify any other files** — only `extensions/catalog.community.json`
|
||||
and `docs/community/extensions.md`
|
||||
1579
.github/workflows/add-community-preset.lock.yml
vendored
1579
.github/workflows/add-community-preset.lock.yml
vendored
File diff suppressed because it is too large
Load Diff
282
.github/workflows/add-community-preset.md
vendored
282
.github/workflows/add-community-preset.md
vendored
@@ -1,282 +0,0 @@
|
||||
---
|
||||
description: "Process community preset submission issues — validate, add to catalog, and open a PR for maintainer review"
|
||||
emoji: "🎨"
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened, edited, labeled]
|
||||
skip-bots: [github-actions, copilot, dependabot]
|
||||
|
||||
tools:
|
||||
edit:
|
||||
bash: ["echo", "cat", "head", "tail", "grep", "wc", "sort", "python3", "jq", "date"]
|
||||
github:
|
||||
toolsets: [issues, repos]
|
||||
web-fetch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: read
|
||||
|
||||
checkout:
|
||||
fetch-depth: 0
|
||||
|
||||
safe-outputs:
|
||||
create-pull-request:
|
||||
title-prefix: "[preset] "
|
||||
labels: [preset-submission, automated]
|
||||
draft: true
|
||||
max: 1
|
||||
protected-files:
|
||||
policy: blocked
|
||||
exclude:
|
||||
- README.md
|
||||
- CHANGELOG.md
|
||||
add-comment:
|
||||
max: 2
|
||||
add-labels:
|
||||
allowed: [preset-submission, validation-passed, validation-failed, needs-info]
|
||||
max: 3
|
||||
---
|
||||
|
||||
# Add Community Preset from Issue Submission
|
||||
|
||||
You are a catalog maintenance agent for the Spec Kit project. Your job is to
|
||||
process community preset submission issues and create pull requests that add
|
||||
or update entries in the community preset catalog.
|
||||
|
||||
## Triggering Conditions
|
||||
|
||||
This workflow triggers on issue events. **Only process the issue if ALL of these
|
||||
conditions are met:**
|
||||
|
||||
1. The issue has the `preset-submission` label
|
||||
2. The issue title starts with `[Preset]:`
|
||||
|
||||
If the issue does not meet these conditions, add a brief comment explaining that
|
||||
this workflow only processes preset submission issues, then stop.
|
||||
|
||||
## Step 1 — Read and Parse the Issue
|
||||
|
||||
Read issue #${{ github.event.issue.number }}.
|
||||
|
||||
Extract the following fields from the structured issue body (GitHub issue form
|
||||
fields):
|
||||
|
||||
| Field | Issue Form ID | Required |
|
||||
|-------|--------------|----------|
|
||||
| Preset ID | `preset-id` | Yes |
|
||||
| Preset Name | `preset-name` | Yes |
|
||||
| Version | `version` | Yes |
|
||||
| Description | `description` | Yes |
|
||||
| Author | `author` | Yes |
|
||||
| Repository URL | `repository` | Yes |
|
||||
| Download URL | `download-url` | Yes |
|
||||
| License | `license` | Yes |
|
||||
| Required Spec Kit Version | `speckit-version` | Yes |
|
||||
| Required Extensions | `required-extensions` | No |
|
||||
| Templates Provided | `templates-provided` | Yes |
|
||||
| Commands Provided | `commands-provided` | Yes |
|
||||
| Number of Scripts | `scripts-count` | No (default 0) |
|
||||
| Tags | `tags` | Yes |
|
||||
|
||||
The issue body uses GitHub's issue form format. Each field appears under a
|
||||
heading matching the field label (e.g., `### Preset ID` followed by the
|
||||
value). Parse accordingly.
|
||||
|
||||
## Step 2 — Validate the Submission
|
||||
|
||||
Run **all** of the following validation checks. Collect all results before
|
||||
deciding pass/fail:
|
||||
|
||||
### 2a. Preset ID format
|
||||
- Must match regex: `^[a-z][a-z0-9-]*$`
|
||||
- Must be lowercase with hyphens only
|
||||
|
||||
### 2b. Version format
|
||||
- Must follow semver: `X.Y.Z` (digits only, no `v` prefix)
|
||||
|
||||
### 2c. Repository validation
|
||||
- Fetch the repository URL — confirm it exists and is publicly accessible
|
||||
- Confirm the repository contains a `preset.yml` file
|
||||
- Confirm the repository contains a `README.md` file
|
||||
- Confirm the repository contains a `LICENSE` file
|
||||
|
||||
### 2d. Release and download URL validation
|
||||
- The download URL should follow the pattern
|
||||
`https://github.com/<owner>/<repo>/archive/refs/tags/v<version>.zip`
|
||||
or
|
||||
`https://github.com/<owner>/<repo>/releases/download/<tag>/<asset>.zip`
|
||||
- Verify a GitHub release exists matching the submitted version
|
||||
|
||||
### 2e. Submission checklists
|
||||
- Confirm that all required checkboxes in the Testing Checklist and Submission
|
||||
Requirements sections are checked (`[x]`)
|
||||
|
||||
### Validation outcome
|
||||
|
||||
If **any** validation fails:
|
||||
1. Add a comment on the issue listing each failed check with a clear explanation
|
||||
of what's wrong and how to fix it
|
||||
2. Add the `validation-failed` label
|
||||
3. **Stop — do not proceed further**
|
||||
|
||||
If all validations pass:
|
||||
1. Add the `validation-passed` label
|
||||
2. Continue to Step 3
|
||||
|
||||
## Step 3 — Determine Add vs Update
|
||||
|
||||
Search `presets/catalog.community.json` for the preset ID.
|
||||
|
||||
- **Not found** → this is a **new addition**
|
||||
- **Found** → this is an **update** — replace the existing entry in-place;
|
||||
preserve `created_at` from the existing entry
|
||||
|
||||
## Step 4 — Update `presets/catalog.community.json`
|
||||
|
||||
Edit `presets/catalog.community.json` to add or update the preset entry.
|
||||
|
||||
### For a new preset
|
||||
|
||||
Insert the entry in **alphabetical order by preset ID** within the
|
||||
`"presets"` object. Use this structure:
|
||||
|
||||
```json
|
||||
{
|
||||
"<id>": {
|
||||
"name": "<name>",
|
||||
"id": "<id>",
|
||||
"version": "<version>",
|
||||
"description": "<description>",
|
||||
"author": "<author>",
|
||||
"repository": "<repository>",
|
||||
"download_url": "<download_url>",
|
||||
"homepage": "<homepage or repository>",
|
||||
"documentation": "<documentation or repository README>",
|
||||
"license": "<license>",
|
||||
"requires": {
|
||||
"speckit_version": "<speckit_version>"
|
||||
},
|
||||
"provides": {
|
||||
"templates": <N>,
|
||||
"commands": <N>
|
||||
},
|
||||
"tags": ["<tag1>", "<tag2>"],
|
||||
"created_at": "<today>T00:00:00Z",
|
||||
"updated_at": "<today>T00:00:00Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
If the preset has required extensions, add an `"extensions"` array inside
|
||||
`"requires"`:
|
||||
|
||||
```json
|
||||
"requires": {
|
||||
"speckit_version": "<speckit_version>",
|
||||
"extensions": ["<extension-id>"]
|
||||
}
|
||||
```
|
||||
|
||||
If the preset provides scripts, add `"scripts": <N>` inside `"provides"`.
|
||||
|
||||
### For an update
|
||||
|
||||
Replace only the changed fields (typically `version`, `download_url`,
|
||||
`description`, `provides`, `requires`, `tags`, `updated_at`). **Preserve**
|
||||
`created_at` from the existing entry.
|
||||
|
||||
### Counting templates and commands
|
||||
|
||||
Parse the "Templates Provided" and "Commands Provided" issue fields:
|
||||
- Count the number of list items (lines starting with `-`)
|
||||
- If the field says "None", the count is 0
|
||||
|
||||
### After editing
|
||||
|
||||
Update the **top-level `"updated_at"` timestamp** in the catalog to today's date
|
||||
in ISO 8601 format.
|
||||
|
||||
Validate the JSON by running:
|
||||
|
||||
```bash
|
||||
python3 -c "import json; json.load(open('presets/catalog.community.json')); print('Valid JSON')"
|
||||
```
|
||||
|
||||
If validation fails, fix the JSON and re-validate before continuing.
|
||||
|
||||
## Step 5 — Update `docs/community/presets.md`
|
||||
|
||||
Edit `docs/community/presets.md` to add or update a row in the Community
|
||||
Presets table.
|
||||
|
||||
### For a new preset
|
||||
|
||||
Insert a new row in **alphabetical order by preset name**:
|
||||
|
||||
```
|
||||
| <Name> | <Description> | <N> templates, <N> commands | <Requires> | [<repo-name>](<repository-url>) |
|
||||
```
|
||||
|
||||
For the Requires column:
|
||||
- Use `—` if no extensions are required
|
||||
- List required extension names if any (e.g., `AIDE extension`)
|
||||
|
||||
If the preset provides scripts, include them: `<N> templates, <N> commands, <N> scripts`
|
||||
|
||||
### For an update
|
||||
|
||||
Find the existing row and update any changed fields in-place.
|
||||
|
||||
## Step 6 — Create Pull Request
|
||||
|
||||
Create a pull request with the changes. Use this branch naming convention:
|
||||
|
||||
- **New preset:** `add-<preset-id>-preset`
|
||||
- **Update:** `update-<preset-id>-preset`
|
||||
|
||||
### Commit message
|
||||
|
||||
For a new preset:
|
||||
```
|
||||
Add <Name> preset to community catalog
|
||||
|
||||
Add <id> preset submitted by @<issue-author> to:
|
||||
- presets/catalog.community.json (alphabetical order)
|
||||
- docs/community/presets.md community presets table
|
||||
|
||||
Closes #<issue-number>
|
||||
```
|
||||
|
||||
For an update:
|
||||
```
|
||||
Update <Name> preset to v<version>
|
||||
|
||||
Update <id> preset submitted by @<issue-author>:
|
||||
- presets/catalog.community.json (version, download_url, etc.)
|
||||
- docs/community/presets.md community presets table
|
||||
|
||||
Closes #<issue-number>
|
||||
```
|
||||
|
||||
### PR description
|
||||
|
||||
Include:
|
||||
- A summary of what changed
|
||||
- Validation results (all checks passed)
|
||||
- `Closes #${{ github.event.issue.number }}`
|
||||
- `cc @<issue-author>` — mention the submitter
|
||||
|
||||
## Important Rules
|
||||
|
||||
- **Alphabetical order matters** — entries must be sorted by ID in the JSON and
|
||||
by name in the docs table
|
||||
- **Always validate JSON** after editing — a trailing comma or missing brace
|
||||
will break the catalog
|
||||
- **Use `Closes` not `Fixes`** — `Closes #N` is the correct keyword for
|
||||
submission issues
|
||||
- **Preserve `created_at` on updates** — keep the original value; only update
|
||||
`updated_at`
|
||||
- **Do not modify any other files** — only `presets/catalog.community.json`
|
||||
and `docs/community/presets.md`
|
||||
22
.github/workflows/lint.yml
vendored
22
.github/workflows/lint.yml
vendored
@@ -13,28 +13,6 @@ jobs:
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
- name: Run git diff --check
|
||||
shell: bash
|
||||
env:
|
||||
EVENT_NAME: ${{ github.event_name }}
|
||||
PR_BASE_SHA: ${{ github.event.pull_request.base.sha }}
|
||||
PUSH_BEFORE_SHA: ${{ github.event.before }}
|
||||
GITHUB_SHA: ${{ github.sha }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
if [ "$EVENT_NAME" = "pull_request" ]; then
|
||||
git fetch --no-tags --depth=1 origin "+${PR_BASE_SHA}:refs/checks/pr-base"
|
||||
git diff --check refs/checks/pr-base HEAD
|
||||
elif [ "$PUSH_BEFORE_SHA" = "0000000000000000000000000000000000000000" ]; then
|
||||
git diff-tree --check --no-commit-id --root -r "$GITHUB_SHA"
|
||||
else
|
||||
git fetch --no-tags --depth=1 origin "+${PUSH_BEFORE_SHA}:refs/checks/push-before"
|
||||
git diff --check refs/checks/push-before HEAD
|
||||
fi
|
||||
|
||||
- name: Run markdownlint-cli2
|
||||
uses: DavidAnson/markdownlint-cli2-action@ded1f9488f68a970bc66ea5619e13e9b52e601cd # v23
|
||||
|
||||
14
CHANGELOG.md
14
CHANGELOG.md
@@ -2,20 +2,6 @@
|
||||
|
||||
<!-- insert new changelog below this comment -->
|
||||
|
||||
## [0.8.13] - 2026-05-21
|
||||
|
||||
### Changed
|
||||
|
||||
- fix: while/do-while loop condition reads stale iteration-0 step output (#2662)
|
||||
- docs: fix directory hierarchy in README examples (#2639)
|
||||
- fix(catalogs): reject boolean priority in extension and preset catalog readers (#2589)
|
||||
- Update Agent Governance extension to v1.2.0 (#2659)
|
||||
- Add agentic workflows for community catalog submissions (#2655)
|
||||
- feat: add self-check tip to check output (#2574)
|
||||
- fix(cli): clarify exception diagnostics (#2602)
|
||||
- ci: add diff whitespace check (#2572)
|
||||
- chore: release 0.8.12, begin 0.8.13.dev0 development (#2648)
|
||||
|
||||
## [0.8.12] - 2026-05-20
|
||||
|
||||
### Changed
|
||||
|
||||
84
README.md
84
README.md
@@ -400,24 +400,23 @@ The produced specification should contain a set of user stories and functional r
|
||||
At this stage, your project folder contents should resemble the following:
|
||||
|
||||
```text
|
||||
.
|
||||
├── .specify
|
||||
│ ├── memory
|
||||
│ │ └── constitution.md
|
||||
│ ├── scripts
|
||||
│ │ └── bash
|
||||
│ │ ├── check-prerequisites.sh
|
||||
│ │ ├── common.sh
|
||||
│ │ ├── create-new-feature.sh
|
||||
│ │ ├── setup-plan.sh
|
||||
│ │ └── setup-tasks.sh
|
||||
│ └── templates
|
||||
│ ├── plan-template.md
|
||||
│ ├── spec-template.md
|
||||
│ └── tasks-template.md
|
||||
└── specs
|
||||
└── 001-create-taskify
|
||||
└── spec.md
|
||||
└── .specify
|
||||
├── memory
|
||||
│ └── constitution.md
|
||||
├── scripts
|
||||
│ └── bash
|
||||
│ ├── check-prerequisites.sh
|
||||
│ ├── common.sh
|
||||
│ ├── create-new-feature.sh
|
||||
│ ├── setup-plan.sh
|
||||
│ └── setup-tasks.sh
|
||||
├── specs
|
||||
│ └── 001-create-taskify
|
||||
│ └── spec.md
|
||||
└── templates
|
||||
├── plan-template.md
|
||||
├── spec-template.md
|
||||
└── tasks-template.md
|
||||
```
|
||||
|
||||
### **STEP 3:** Functional specification clarification (required before planning)
|
||||
@@ -464,31 +463,30 @@ The output of this step will include a number of implementation detail documents
|
||||
```text
|
||||
.
|
||||
├── CLAUDE.md
|
||||
├── .specify
|
||||
│ ├── memory
|
||||
│ │ └── constitution.md
|
||||
│ ├── scripts
|
||||
│ │ └── bash
|
||||
│ │ ├── check-prerequisites.sh
|
||||
│ │ ├── common.sh
|
||||
│ │ ├── create-new-feature.sh
|
||||
│ │ ├── setup-plan.sh
|
||||
│ │ └── setup-tasks.sh
|
||||
│ └── templates
|
||||
│ ├── CLAUDE-template.md
|
||||
│ ├── plan-template.md
|
||||
│ ├── spec-template.md
|
||||
│ └── tasks-template.md
|
||||
└── specs
|
||||
└── 001-create-taskify
|
||||
├── contracts
|
||||
│ ├── api-spec.json
|
||||
│ └── signalr-spec.md
|
||||
├── data-model.md
|
||||
├── plan.md
|
||||
├── quickstart.md
|
||||
├── research.md
|
||||
└── spec.md
|
||||
├── memory
|
||||
│ └── constitution.md
|
||||
├── scripts
|
||||
│ └── bash
|
||||
│ ├── check-prerequisites.sh
|
||||
│ ├── common.sh
|
||||
│ ├── create-new-feature.sh
|
||||
│ ├── setup-plan.sh
|
||||
│ └── setup-tasks.sh
|
||||
├── specs
|
||||
│ └── 001-create-taskify
|
||||
│ ├── contracts
|
||||
│ │ ├── api-spec.json
|
||||
│ │ └── signalr-spec.md
|
||||
│ ├── data-model.md
|
||||
│ ├── plan.md
|
||||
│ ├── quickstart.md
|
||||
│ ├── research.md
|
||||
│ └── spec.md
|
||||
└── templates
|
||||
├── CLAUDE-template.md
|
||||
├── plan-template.md
|
||||
├── spec-template.md
|
||||
└── tasks-template.md
|
||||
```
|
||||
|
||||
Check the `research.md` document to ensure that the right tech stack is used, based on your instructions. You can ask Claude Code to refine it if any of the components stand out, or even have it check the locally-installed version of the platform/framework you want to use (e.g., .NET).
|
||||
|
||||
@@ -23,7 +23,7 @@ The following community-contributed extensions are available in [`catalog.commun
|
||||
| Extension | Purpose | Category | Effect | URL |
|
||||
|-----------|---------|----------|--------|-----|
|
||||
| Agent Assign | Assign specialized Claude Code agents to spec-kit tasks for targeted execution | `process` | Read+Write | [spec-kit-agent-assign](https://github.com/xymelon/spec-kit-agent-assign) |
|
||||
| Agent Governance | Generate agent-platform repository governance files from Spec Kit metadata | `process` | Read+Write | [spec-kit-agent-governance](https://github.com/bigsmartben/spec-kit-agent-governance) |
|
||||
| Agent Governance | Project-local agent governance memory and context projection | `process` | Read+Write | [spec-kit-agent-governance](https://github.com/bigsmartben/spec-kit-agent-governance) |
|
||||
| AI-Driven Engineering (AIDE) | A structured 7-step workflow for building new projects from scratch with AI assistants — from vision through implementation | `process` | Read+Write | [aide](https://github.com/mnriem/spec-kit-extensions/tree/main/aide) |
|
||||
| API Evolve | Managed API contract evolution — breaking-change detection, semver enforcement, deprecation orchestration, and lifecycle gates across REST, GraphQL, and gRPC | `process` | Read+Write | [spec-kit-api-evolve](https://github.com/Quratulain-bilal/spec-kit-api-evolve) |
|
||||
| Architect Impact Previewer | Predicts architectural impact, complexity, and risks of proposed changes before implementation. | `visibility` | Read-only | [spec-kit-architect-preview](https://github.com/UmmeHabiba1312/spec-kit-architect-preview) |
|
||||
|
||||
@@ -69,8 +69,6 @@ specify check
|
||||
|
||||
Checks that required tools are available on your system: `git` and any CLI-based AI coding agents. IDE-based agents are skipped since they don't require a CLI tool.
|
||||
|
||||
This command stays offline. If a command behaves like an older Spec Kit version or an expected CLI feature is missing, run `specify self check` to check whether your local CLI is behind the latest release.
|
||||
|
||||
## Version Information
|
||||
|
||||
```bash
|
||||
|
||||
@@ -388,14 +388,6 @@ Only Spec Kit infrastructure files:
|
||||
|
||||
### "CLI upgrade doesn't seem to work"
|
||||
|
||||
If a command behaves like an older Spec Kit version, first check for local CLI drift:
|
||||
|
||||
```bash
|
||||
specify self check
|
||||
```
|
||||
|
||||
`specify check` is an offline environment scan; `specify self check` is the CLI version lookup.
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"updated_at": "2026-05-21T00:00:00Z",
|
||||
"updated_at": "2026-05-20T00:00:00Z",
|
||||
"catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.community.json",
|
||||
"extensions": {
|
||||
"aide": {
|
||||
@@ -71,10 +71,10 @@
|
||||
"agent-governance": {
|
||||
"name": "Agent Governance",
|
||||
"id": "agent-governance",
|
||||
"description": "Generate agent-platform repository governance files from Spec Kit metadata.",
|
||||
"description": "Project-local agent governance memory and context projection.",
|
||||
"author": "bigben",
|
||||
"version": "1.2.0",
|
||||
"download_url": "https://github.com/bigsmartben/spec-kit-agent-governance/archive/refs/tags/v1.2.0.zip",
|
||||
"version": "1.1.0",
|
||||
"download_url": "https://github.com/bigsmartben/spec-kit-agent-governance/archive/refs/tags/v1.1.0.zip",
|
||||
"repository": "https://github.com/bigsmartben/spec-kit-agent-governance",
|
||||
"homepage": "https://github.com/bigsmartben/spec-kit-agent-governance",
|
||||
"documentation": "https://github.com/bigsmartben/spec-kit-agent-governance/blob/main/README.md",
|
||||
@@ -84,8 +84,8 @@
|
||||
"speckit_version": ">=0.8.0",
|
||||
"tools": [
|
||||
{
|
||||
"name": "uv",
|
||||
"required": true
|
||||
"name": "python3",
|
||||
"required": false
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -103,7 +103,7 @@
|
||||
"downloads": 0,
|
||||
"stars": 0,
|
||||
"created_at": "2026-05-14T00:00:00Z",
|
||||
"updated_at": "2026-05-21T00:00:00Z"
|
||||
"updated_at": "2026-05-15T00:00:00Z"
|
||||
},
|
||||
"agent-orchestrator": {
|
||||
"name": "Intelligent Agent Orchestrator",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "specify-cli"
|
||||
version = "0.8.13"
|
||||
version = "0.8.12"
|
||||
description = "Specify CLI, part of GitHub Spec Kit. A tool to bootstrap your projects for Spec-Driven Development (SDD)."
|
||||
requires-python = ">=3.11"
|
||||
dependencies = [
|
||||
|
||||
@@ -427,35 +427,6 @@ def _get_skills_dir(project_path: Path, selected_ai: str) -> Path:
|
||||
return project_path / ".agents" / "skills"
|
||||
|
||||
|
||||
def _cli_error_detail(exc: BaseException) -> str:
|
||||
"""Return a compact one-line exception detail for CLI output."""
|
||||
detail = str(exc).replace("\n", " ").strip()
|
||||
return detail or exc.__class__.__name__
|
||||
|
||||
|
||||
def _cli_phase_label(phase: str, target_kind: str, target: str | None = None) -> str:
|
||||
"""Format a stable operation label for user-visible diagnostics."""
|
||||
label = f"{phase} {target_kind}".strip()
|
||||
if target:
|
||||
label = f"{label} '{target}'"
|
||||
return label
|
||||
|
||||
|
||||
def _print_cli_warning(
|
||||
phase: str,
|
||||
target_kind: str,
|
||||
target: str | None,
|
||||
exc: BaseException,
|
||||
*,
|
||||
continuing: str | None = None,
|
||||
) -> None:
|
||||
"""Print a warning that names the failed CLI phase and target."""
|
||||
label = _cli_phase_label(phase, target_kind, target)
|
||||
console.print(f"[yellow]Warning:[/yellow] Failed to {label}: {_cli_error_detail(exc)}")
|
||||
if continuing:
|
||||
console.print(f"[dim]{continuing}[/dim]")
|
||||
|
||||
|
||||
# Constants kept for backward compatibility with presets and extensions.
|
||||
DEFAULT_SKILLS_DIR = ".agents/skills"
|
||||
SKILL_DESCRIPTIONS = {
|
||||
@@ -888,8 +859,9 @@ def init(
|
||||
git_messages.append("bundled extension not found")
|
||||
except Exception as ext_err:
|
||||
git_has_error = True
|
||||
sanitized_ext = str(ext_err).replace('\n', ' ').strip()
|
||||
git_messages.append(
|
||||
f"extension install failed during optional git setup: {_cli_error_detail(ext_err)[:120]}"
|
||||
f"extension install failed: {sanitized_ext[:120]}"
|
||||
)
|
||||
summary = "; ".join(git_messages)
|
||||
if git_has_error:
|
||||
@@ -927,10 +899,8 @@ def init(
|
||||
else:
|
||||
tracker.skip("workflow", "bundled workflow not found")
|
||||
except Exception as wf_err:
|
||||
tracker.error(
|
||||
"workflow",
|
||||
f"install bundled workflow 'speckit' failed: {_cli_error_detail(wf_err)[:120]}",
|
||||
)
|
||||
sanitized_wf = str(wf_err).replace('\n', ' ').strip()
|
||||
tracker.error("workflow", f"install failed: {sanitized_wf[:120]}")
|
||||
|
||||
# Fix permissions after all installs (scripts + extensions)
|
||||
ensure_executable_scripts(project_path, tracker=tracker)
|
||||
@@ -992,13 +962,7 @@ def init(
|
||||
zip_path = preset_catalog.download_pack(preset)
|
||||
preset_manager.install_from_zip(zip_path, speckit_ver)
|
||||
except PresetError as preset_err:
|
||||
_print_cli_warning(
|
||||
"install",
|
||||
"preset",
|
||||
preset,
|
||||
preset_err,
|
||||
continuing="Continuing without the optional preset.",
|
||||
)
|
||||
console.print(f"[yellow]Warning:[/yellow] Failed to install preset '{preset}': {preset_err}")
|
||||
finally:
|
||||
if zip_path is not None:
|
||||
# Clean up downloaded ZIP to avoid cache accumulation
|
||||
@@ -1008,14 +972,7 @@ def init(
|
||||
# Best-effort cleanup; failure to delete is non-fatal
|
||||
pass
|
||||
except Exception as preset_err:
|
||||
# Optional preset install must not abort project initialization.
|
||||
_print_cli_warning(
|
||||
"install",
|
||||
"preset",
|
||||
preset,
|
||||
preset_err,
|
||||
continuing="Continuing without the optional preset.",
|
||||
)
|
||||
console.print(f"[yellow]Warning:[/yellow] Failed to install preset: {preset_err}")
|
||||
|
||||
tracker.complete("final", "project ready")
|
||||
except (typer.Exit, SystemExit):
|
||||
@@ -1200,8 +1157,6 @@ def check():
|
||||
if not any(agent_results.values()):
|
||||
console.print("[dim]Tip: Install a coding agent for the best experience[/dim]")
|
||||
|
||||
console.print("[dim]Tip: Run 'specify self check' to verify you have the latest CLI version[/dim]")
|
||||
|
||||
|
||||
def _feature_capabilities() -> dict[str, bool]:
|
||||
"""Return stable local CLI capability flags for humans and agents."""
|
||||
@@ -1738,29 +1693,20 @@ def integration_install(
|
||||
if new_default == integration.key:
|
||||
_update_init_options_for_integration(project_root, integration, script_type=selected_script)
|
||||
|
||||
except Exception as exc:
|
||||
except Exception as e:
|
||||
# Attempt rollback of any files written by setup
|
||||
try:
|
||||
integration.teardown(project_root, manifest, force=True)
|
||||
except Exception as rollback_err:
|
||||
# Suppress so the original setup error remains the primary failure
|
||||
_print_cli_warning(
|
||||
"rollback",
|
||||
"integration",
|
||||
key,
|
||||
rollback_err,
|
||||
continuing="The original install failure is still the primary error.",
|
||||
)
|
||||
console.print(f"[yellow]Warning:[/yellow] Failed to roll back integration changes: {rollback_err}")
|
||||
if installed_keys:
|
||||
_write_integration_json(
|
||||
project_root, default_key, installed_keys, _integration_settings(current)
|
||||
)
|
||||
else:
|
||||
_remove_integration_json(project_root)
|
||||
console.print(
|
||||
f"[red]Error:[/red] Failed to {_cli_phase_label('install', 'integration', key)}: "
|
||||
f"{_cli_error_detail(exc)}"
|
||||
)
|
||||
console.print(f"[red]Error:[/red] Failed to install integration: {e}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
name = (integration.config or {}).get("name", key)
|
||||
@@ -2124,12 +2070,9 @@ def integration_switch(
|
||||
ext_mgr = ExtensionManager(project_root)
|
||||
ext_mgr.unregister_agent_artifacts(installed_key)
|
||||
except Exception as ext_err:
|
||||
_print_cli_warning(
|
||||
"clean up extension artifacts for",
|
||||
"integration",
|
||||
installed_key,
|
||||
ext_err,
|
||||
continuing="Continuing with integration switch; old extension artifacts may need manual cleanup.",
|
||||
console.print(
|
||||
f"[yellow]Warning:[/yellow] Could not clean up extension artifacts "
|
||||
f"(commands, skills, registry entries) for '{installed_key}': {ext_err}"
|
||||
)
|
||||
|
||||
# Clear metadata so a failed Phase 2 doesn't leave stale references
|
||||
@@ -2224,27 +2167,18 @@ def integration_switch(
|
||||
ext_mgr = ExtensionManager(project_root)
|
||||
ext_mgr.register_enabled_extensions_for_agent(target)
|
||||
except Exception as ext_err:
|
||||
_print_cli_warning(
|
||||
"register extension artifacts for",
|
||||
"integration",
|
||||
target,
|
||||
ext_err,
|
||||
continuing="The integration switch succeeded, but installed extensions may need re-registration.",
|
||||
console.print(
|
||||
f"[yellow]Warning:[/yellow] Could not register extension commands, skills, "
|
||||
f"or related artifacts for '{target}': {ext_err}"
|
||||
)
|
||||
|
||||
except Exception as exc:
|
||||
except Exception as e:
|
||||
# Attempt rollback of any files written by setup
|
||||
try:
|
||||
target_integration.teardown(project_root, manifest, force=True)
|
||||
except Exception as rollback_err:
|
||||
# Suppress so the original setup error remains the primary failure
|
||||
_print_cli_warning(
|
||||
"rollback",
|
||||
"integration",
|
||||
target,
|
||||
rollback_err,
|
||||
continuing="The original switch failure is still the primary error.",
|
||||
)
|
||||
console.print(f"[yellow]Warning:[/yellow] Failed to roll back integration '{target}': {rollback_err}")
|
||||
if installed_keys:
|
||||
fallback_key = installed_keys[0]
|
||||
fallback_integration = get_integration(fallback_key)
|
||||
@@ -2273,10 +2207,7 @@ def integration_switch(
|
||||
)
|
||||
else:
|
||||
_remove_integration_json(project_root)
|
||||
console.print(
|
||||
f"[red]Error:[/red] Failed to {_cli_phase_label('install', 'integration', target)} "
|
||||
f"during switch: {_cli_error_detail(exc)}"
|
||||
)
|
||||
console.print(f"[red]Error:[/red] Failed to install integration '{target}': {e}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
name = (target_integration.config or {}).get("name", target)
|
||||
@@ -2411,8 +2342,7 @@ def integration_upgrade(
|
||||
except Exception as exc:
|
||||
# Don't teardown — setup overwrites in-place, so teardown would
|
||||
# delete files that were working before the upgrade. Just report.
|
||||
console.print(f"[red]Error:[/red] Failed to {_cli_phase_label('upgrade', 'integration', key)}.")
|
||||
console.print(f"[dim]Details:[/dim] {_cli_error_detail(exc)}")
|
||||
console.print(f"[red]Error:[/red] Failed to upgrade integration: {exc}")
|
||||
console.print("[yellow]The previous integration files may still be in place.[/yellow]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@@ -1903,24 +1903,12 @@ class PresetCatalog:
|
||||
if not url:
|
||||
continue
|
||||
self._validate_catalog_url(url)
|
||||
raw_priority = item.get("priority", idx + 1)
|
||||
# Reject bools explicitly: ``bool`` is a subclass of ``int`` so
|
||||
# ``int(True)`` silently returns 1, which would let a YAML
|
||||
# ``priority: true`` slip through as a valid priority of 1. The
|
||||
# sibling integration-catalog reader in ``catalogs.py`` already
|
||||
# guards this; mirror the check here so the three catalog
|
||||
# validators stay consistent.
|
||||
if isinstance(raw_priority, bool):
|
||||
raise PresetValidationError(
|
||||
f"Invalid priority for catalog '{item.get('name', idx + 1)}': "
|
||||
f"expected integer, got {raw_priority!r}"
|
||||
)
|
||||
try:
|
||||
priority = int(raw_priority)
|
||||
priority = int(item.get("priority", idx + 1))
|
||||
except (TypeError, ValueError):
|
||||
raise PresetValidationError(
|
||||
f"Invalid priority for catalog '{item.get('name', idx + 1)}': "
|
||||
f"expected integer, got {raw_priority!r}"
|
||||
f"expected integer, got {item.get('priority')!r}"
|
||||
)
|
||||
raw_install = item.get("install_allowed", False)
|
||||
if isinstance(raw_install, str):
|
||||
|
||||
@@ -673,29 +673,22 @@ class WorkflowEngine:
|
||||
if not evaluate_condition(condition, context):
|
||||
break
|
||||
# Namespace nested step IDs per iteration
|
||||
# so logs and state keys are unique.
|
||||
# Execute one step at a time and alias each
|
||||
# result back to the unprefixed key so that
|
||||
# later steps in the same body and the loop
|
||||
# condition see the latest values.
|
||||
for ns_idx, ns in enumerate(result.next_steps):
|
||||
iter_steps = []
|
||||
for ns in result.next_steps:
|
||||
ns_copy = dict(ns)
|
||||
orig = ns_copy.get("id")
|
||||
base_id = orig or f"step-{ns_idx}"
|
||||
ns_copy["id"] = f"{step_id}:{base_id}:{_loop_iter + 1}"
|
||||
self._execute_steps(
|
||||
[ns_copy], context, state, registry,
|
||||
step_offset=-1,
|
||||
)
|
||||
if state.status in (
|
||||
RunStatus.PAUSED,
|
||||
RunStatus.FAILED,
|
||||
RunStatus.ABORTED,
|
||||
):
|
||||
return
|
||||
if orig and ns_copy["id"] in context.steps:
|
||||
context.steps[orig] = context.steps[ns_copy["id"]]
|
||||
state.step_results[orig] = context.steps[ns_copy["id"]]
|
||||
if "id" in ns_copy:
|
||||
ns_copy["id"] = f"{step_id}:{ns_copy['id']}:{_loop_iter + 1}"
|
||||
iter_steps.append(ns_copy)
|
||||
self._execute_steps(
|
||||
iter_steps, context, state, registry,
|
||||
step_offset=-1,
|
||||
)
|
||||
if state.status in (
|
||||
RunStatus.PAUSED,
|
||||
RunStatus.FAILED,
|
||||
RunStatus.ABORTED,
|
||||
):
|
||||
return
|
||||
|
||||
# Fan-out: execute nested step template per item with unique IDs
|
||||
if step_type == "fan-out":
|
||||
|
||||
@@ -22,26 +22,6 @@ def _normalize_cli_output(output: str) -> str:
|
||||
return output.strip()
|
||||
|
||||
|
||||
class TestCliDiagnosticFormatting:
|
||||
def test_cli_error_detail_flattens_newlines(self):
|
||||
import specify_cli
|
||||
|
||||
assert specify_cli._cli_error_detail(RuntimeError("line one\nline two")) == "line one line two"
|
||||
|
||||
def test_cli_error_detail_handles_empty_message(self):
|
||||
import specify_cli
|
||||
|
||||
assert specify_cli._cli_error_detail(RuntimeError()) == "RuntimeError"
|
||||
|
||||
def test_cli_phase_label_includes_target(self):
|
||||
import specify_cli
|
||||
|
||||
assert (
|
||||
specify_cli._cli_phase_label("rollback", "integration", "codex")
|
||||
== "rollback integration 'codex'"
|
||||
)
|
||||
|
||||
|
||||
class TestInitIntegrationFlag:
|
||||
def test_integration_and_ai_mutually_exclusive(self, tmp_path):
|
||||
from typer.testing import CliRunner
|
||||
@@ -194,42 +174,6 @@ class TestInitIntegrationFlag:
|
||||
assert normalized_output.index("Deprecation Warning") < normalized_output.index("Next Steps")
|
||||
assert (project / ".myagent" / "commands" / "speckit.plan.md").exists()
|
||||
|
||||
def test_init_optional_preset_failure_reports_target_and_continues(
|
||||
self, tmp_path, monkeypatch
|
||||
):
|
||||
from typer.testing import CliRunner
|
||||
from specify_cli import app
|
||||
from specify_cli.presets import PresetManager
|
||||
|
||||
def fail_install(self, path, version):
|
||||
raise OSError("preset install exploded\nwith context")
|
||||
|
||||
monkeypatch.setattr(PresetManager, "install_from_directory", fail_install)
|
||||
|
||||
project = tmp_path / "init-preset-warning"
|
||||
result = CliRunner().invoke(
|
||||
app,
|
||||
[
|
||||
"init",
|
||||
str(project),
|
||||
"--integration",
|
||||
"copilot",
|
||||
"--script",
|
||||
"sh",
|
||||
"--no-git",
|
||||
"--preset",
|
||||
"lean",
|
||||
],
|
||||
catch_exceptions=False,
|
||||
)
|
||||
normalized = _normalize_cli_output(result.output)
|
||||
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "Failed to install preset 'lean'" in normalized
|
||||
assert "preset install exploded with context" in normalized
|
||||
assert "Continuing without the optional preset" in normalized
|
||||
assert "Project ready" in normalized
|
||||
|
||||
def test_ai_claude_here_preserves_preexisting_commands(self, tmp_path):
|
||||
from typer.testing import CliRunner
|
||||
from specify_cli import app
|
||||
@@ -1111,143 +1055,6 @@ class TestIntegrationCatalogDiscoveryCLI:
|
||||
finally:
|
||||
os.chdir(old)
|
||||
|
||||
def test_integration_install_failure_reports_phase_target_and_rollback(
|
||||
self, tmp_path, monkeypatch
|
||||
):
|
||||
from specify_cli.integrations import INTEGRATION_REGISTRY
|
||||
from specify_cli.integrations.base import IntegrationBase
|
||||
|
||||
class BrokenIntegration(IntegrationBase):
|
||||
key = "broken-test"
|
||||
config = {
|
||||
"name": "Broken Test",
|
||||
"folder": ".broken/",
|
||||
"commands_subdir": "commands",
|
||||
"install_url": None,
|
||||
"requires_cli": False,
|
||||
}
|
||||
registrar_config = {
|
||||
"dir": ".broken/commands",
|
||||
"format": "markdown",
|
||||
"args": "$ARGUMENTS",
|
||||
"extension": ".md",
|
||||
}
|
||||
context_file = "BROKEN.md"
|
||||
|
||||
def setup(self, project_root, manifest, **kwargs):
|
||||
raise OSError("setup exploded\nwith context")
|
||||
|
||||
def teardown(self, project_root, manifest, force=False):
|
||||
raise OSError("rollback exploded")
|
||||
|
||||
project = self._make_project(tmp_path)
|
||||
monkeypatch.setitem(INTEGRATION_REGISTRY, "broken-test", BrokenIntegration())
|
||||
|
||||
result = self._invoke(["integration", "install", "broken-test"], project)
|
||||
normalized = _normalize_cli_output(result.output)
|
||||
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "Failed to rollback integration 'broken-test'" in normalized
|
||||
assert "rollback exploded" in normalized
|
||||
assert "Failed to install integration 'broken-test'" in normalized
|
||||
assert "setup exploded with context" in normalized
|
||||
|
||||
def test_integration_upgrade_failure_reports_phase_and_target(
|
||||
self, tmp_path, monkeypatch
|
||||
):
|
||||
from specify_cli.integrations import INTEGRATION_REGISTRY
|
||||
from specify_cli.integrations.copilot import CopilotIntegration
|
||||
|
||||
class UpgradeBrokenIntegration(CopilotIntegration):
|
||||
key = "upgrade-broken"
|
||||
config = dict(CopilotIntegration.config)
|
||||
config["name"] = "Upgrade Broken"
|
||||
|
||||
def setup(self, project_root, manifest, **kwargs):
|
||||
raise OSError("upgrade exploded\nwith context")
|
||||
|
||||
project = self._make_project(tmp_path)
|
||||
monkeypatch.setitem(
|
||||
INTEGRATION_REGISTRY, "upgrade-broken", UpgradeBrokenIntegration()
|
||||
)
|
||||
|
||||
(project / ".specify" / "integrations").mkdir(parents=True, exist_ok=True)
|
||||
(project / ".specify" / "integration.json").write_text(
|
||||
json.dumps(
|
||||
{
|
||||
"version": 1,
|
||||
"integration": "upgrade-broken",
|
||||
"integrations": ["upgrade-broken"],
|
||||
"integration_settings": {"upgrade-broken": {"script": "sh"}},
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
(
|
||||
project / ".specify" / "integrations" / "upgrade-broken.manifest.json"
|
||||
).write_text(
|
||||
json.dumps(
|
||||
{
|
||||
"integration": "upgrade-broken",
|
||||
"version": "0.0.0",
|
||||
"installed_at": "2026-05-16T00:00:00+00:00",
|
||||
"files": {},
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
result = self._invoke(["integration", "upgrade", "upgrade-broken"], project)
|
||||
normalized = _normalize_cli_output(result.output)
|
||||
|
||||
assert result.exit_code == 1, result.output
|
||||
assert "Failed to upgrade integration 'upgrade-broken'" in normalized
|
||||
assert "upgrade exploded with context" in normalized
|
||||
assert "previous integration files may still be in place" in normalized
|
||||
|
||||
def test_integration_switch_cleanup_warning_reports_phase_and_targets(
|
||||
self, tmp_path, monkeypatch
|
||||
):
|
||||
from specify_cli.extensions import ExtensionManager
|
||||
|
||||
project = self._make_project(tmp_path)
|
||||
(project / ".specify" / "integrations").mkdir(parents=True, exist_ok=True)
|
||||
(project / ".specify" / "integration.json").write_text(
|
||||
json.dumps(
|
||||
{
|
||||
"version": 1,
|
||||
"integration": "copilot",
|
||||
"integrations": ["copilot"],
|
||||
"integration_settings": {"copilot": {"script": "sh"}},
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
(project / ".specify" / "integrations" / "copilot.manifest.json").write_text(
|
||||
json.dumps(
|
||||
{
|
||||
"integration": "copilot",
|
||||
"version": "0.0.0",
|
||||
"installed_at": "2026-05-16T00:00:00+00:00",
|
||||
"files": {},
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
def fail_cleanup(self, integration_key):
|
||||
raise OSError("cleanup exploded")
|
||||
|
||||
monkeypatch.setattr(ExtensionManager, "unregister_agent_artifacts", fail_cleanup)
|
||||
|
||||
result = self._invoke(["integration", "switch", "claude"], project)
|
||||
normalized = _normalize_cli_output(result.output)
|
||||
|
||||
assert result.exit_code == 0, result.output
|
||||
assert "Failed to clean up extension artifacts for integration 'copilot'" in normalized
|
||||
assert "cleanup exploded" in normalized
|
||||
assert "Switched to integration" in normalized
|
||||
|
||||
# -- Project guard -----------------------------------------------------
|
||||
|
||||
def test_search_requires_specify_project(self, tmp_path):
|
||||
|
||||
@@ -7,13 +7,7 @@ Covers issue https://github.com/github/spec-kit/issues/550:
|
||||
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
from typer.testing import CliRunner
|
||||
|
||||
from specify_cli import app, check_tool
|
||||
from tests.conftest import strip_ansi
|
||||
|
||||
|
||||
runner = CliRunner()
|
||||
from specify_cli import check_tool
|
||||
|
||||
|
||||
class TestCheckToolClaude:
|
||||
@@ -109,32 +103,4 @@ class TestCheckToolOther:
|
||||
return "/usr/bin/kiro" if name == "kiro" else None
|
||||
|
||||
with patch("shutil.which", side_effect=fake_which):
|
||||
assert check_tool("kiro-cli") is True
|
||||
|
||||
|
||||
class TestCheckTip:
|
||||
"""`specify check` should point users to the existing version check."""
|
||||
|
||||
def test_check_shows_self_check_tip(self):
|
||||
with patch("specify_cli.check_tool", return_value=True):
|
||||
result = runner.invoke(app, ["check"])
|
||||
|
||||
output = strip_ansi(result.output)
|
||||
assert result.exit_code == 0
|
||||
assert (
|
||||
"Tip: Run 'specify self check' to verify you have the latest CLI version"
|
||||
in output
|
||||
)
|
||||
|
||||
def test_check_tip_does_not_fetch_latest_release(self):
|
||||
with (
|
||||
patch("specify_cli.check_tool", return_value=True),
|
||||
patch(
|
||||
"specify_cli._version._fetch_latest_release_tag",
|
||||
side_effect=AssertionError("latest release lookup should not run"),
|
||||
) as fetch_latest,
|
||||
):
|
||||
result = runner.invoke(app, ["check"])
|
||||
|
||||
assert result.exit_code == 0
|
||||
fetch_latest.assert_not_called()
|
||||
assert check_tool("kiro-cli") is True
|
||||
@@ -1830,31 +1830,6 @@ class TestPresetCatalogMultiCatalog:
|
||||
with pytest.raises(PresetValidationError, match="Invalid priority"):
|
||||
catalog._load_catalog_config(config_path)
|
||||
|
||||
def test_load_catalog_config_rejects_boolean_priority(self, project_dir):
|
||||
"""A YAML ``priority: true`` is a typo, not a request for priority 1.
|
||||
|
||||
``bool`` is a subclass of ``int`` in Python, so ``int(True)`` silently
|
||||
returns ``1``. Without an explicit guard a malformed config like
|
||||
``priority: yes`` would be accepted as a valid priority of 1 and
|
||||
silently change catalog ordering. The sibling integration-catalog
|
||||
reader rejects this case (see ``catalogs.py``); the preset catalog
|
||||
reader must stay consistent.
|
||||
"""
|
||||
config_path = project_dir / ".specify" / "preset-catalogs.yml"
|
||||
config_path.write_text(yaml.dump({
|
||||
"catalogs": [
|
||||
{
|
||||
"name": "bool-priority",
|
||||
"url": "https://example.com/catalog.json",
|
||||
"priority": True,
|
||||
}
|
||||
]
|
||||
}))
|
||||
|
||||
catalog = PresetCatalog(project_dir)
|
||||
with pytest.raises(PresetValidationError, match="Invalid priority|expected integer"):
|
||||
catalog._load_catalog_config(config_path)
|
||||
|
||||
def test_load_catalog_config_install_allowed_string(self, project_dir):
|
||||
"""Test that install_allowed accepts string values."""
|
||||
config_path = project_dir / ".specify" / "preset-catalogs.yml"
|
||||
|
||||
@@ -463,7 +463,6 @@ class TestCommandStep:
|
||||
assert any("missing 'command'" in e for e in errors)
|
||||
|
||||
def test_step_override_integration(self):
|
||||
from unittest.mock import patch
|
||||
from specify_cli.workflows.steps.command import CommandStep
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
@@ -475,8 +474,7 @@ class TestCommandStep:
|
||||
"integration": "gemini",
|
||||
"input": {},
|
||||
}
|
||||
with patch("specify_cli.workflows.steps.command.shutil.which", return_value=None):
|
||||
result = step.execute(config, ctx)
|
||||
result = step.execute(config, ctx)
|
||||
assert result.output["integration"] == "gemini"
|
||||
|
||||
def test_step_override_model(self):
|
||||
@@ -628,7 +626,6 @@ class TestPromptStep:
|
||||
assert result.output["dispatched"] is False
|
||||
|
||||
def test_execute_with_step_integration(self):
|
||||
from unittest.mock import patch
|
||||
from specify_cli.workflows.steps.prompt import PromptStep
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
@@ -640,12 +637,10 @@ class TestPromptStep:
|
||||
"prompt": "Summarize the codebase",
|
||||
"integration": "gemini",
|
||||
}
|
||||
with patch("specify_cli.workflows.steps.prompt.shutil.which", return_value=None):
|
||||
result = step.execute(config, ctx)
|
||||
result = step.execute(config, ctx)
|
||||
assert result.output["integration"] == "gemini"
|
||||
|
||||
def test_execute_with_model(self):
|
||||
from unittest.mock import patch
|
||||
from specify_cli.workflows.steps.prompt import PromptStep
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
@@ -657,8 +652,7 @@ class TestPromptStep:
|
||||
"prompt": "hello",
|
||||
"model": "opus-4",
|
||||
}
|
||||
with patch("specify_cli.workflows.steps.prompt.shutil.which", return_value=None):
|
||||
result = step.execute(config, ctx)
|
||||
result = step.execute(config, ctx)
|
||||
assert result.output["model"] == "opus-4"
|
||||
|
||||
def test_dispatch_with_mock_cli(self, tmp_path):
|
||||
@@ -1889,268 +1883,6 @@ steps:
|
||||
errors = validate_workflow(definition)
|
||||
assert any("invalid default" in e for e in errors), errors
|
||||
|
||||
def test_while_loop_condition_reads_latest_iteration(self, project_dir):
|
||||
"""Regression: while-loop condition must see updated step output
|
||||
from the most recent iteration, not stale iteration-0 data.
|
||||
|
||||
See https://github.com/github/spec-kit/issues/2592
|
||||
"""
|
||||
from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition
|
||||
from specify_cli.workflows.base import RunStatus
|
||||
|
||||
# Shell step echoes a counter via a file.
|
||||
# Condition: exit_code != 0 means "keep looping" — but a non-zero
|
||||
# exit code would mark the step FAILED and abort the run, so we
|
||||
# use stdout-based comparison instead.
|
||||
#
|
||||
# Iteration 0: counter=1, echoes "1" → not "done" → loop continues
|
||||
# Iteration 1: counter=2, echoes "done" → condition false → stop
|
||||
# Without the fix, condition always reads iteration-0 stdout,
|
||||
# so the loop runs all max_iterations.
|
||||
import sys
|
||||
|
||||
counter_file = project_dir / ".counter"
|
||||
counter_file.write_text("0", encoding="utf-8")
|
||||
py = sys.executable
|
||||
script_file = project_dir / "_tick.py"
|
||||
script_file.write_text(
|
||||
f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"
|
||||
"n = int(p.read_text()) + 1; p.write_text(str(n))\n"
|
||||
"print('done' if n >= 2 else str(n), end='')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
yaml_str = f"""
|
||||
schema_version: "1.0"
|
||||
workflow:
|
||||
id: "while-condition-update"
|
||||
name: "While Condition Update"
|
||||
version: "1.0.0"
|
||||
steps:
|
||||
- id: retry-loop
|
||||
type: while
|
||||
condition: "{{{{ 'done' not in steps.attempt.output.stdout }}}}"
|
||||
max_iterations: 5
|
||||
steps:
|
||||
- id: attempt
|
||||
type: shell
|
||||
run: '"{py}" "{script_file}"'
|
||||
"""
|
||||
definition = WorkflowDefinition.from_string(yaml_str)
|
||||
engine = WorkflowEngine(project_dir)
|
||||
state = engine.execute(definition)
|
||||
|
||||
assert state.status == RunStatus.COMPLETED
|
||||
# The unprefixed key should reflect the latest iteration's result.
|
||||
assert state.step_results["attempt"]["output"]["stdout"] == "done"
|
||||
# Namespaced iteration-1 result should also exist.
|
||||
assert "retry-loop:attempt:1" in state.step_results
|
||||
# Counter should be 2 (iteration 0 + iteration 1), not 5.
|
||||
assert counter_file.read_text(encoding="utf-8").strip() == "2"
|
||||
|
||||
def test_do_while_loop_condition_reads_latest_iteration(self, project_dir):
|
||||
"""Regression: do-while loop condition must also see updated output.
|
||||
|
||||
See https://github.com/github/spec-kit/issues/2592
|
||||
"""
|
||||
from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition
|
||||
from specify_cli.workflows.base import RunStatus
|
||||
|
||||
import sys
|
||||
|
||||
counter_file = project_dir / ".counter"
|
||||
counter_file.write_text("0", encoding="utf-8")
|
||||
py = sys.executable
|
||||
script_file = project_dir / "_tick.py"
|
||||
script_file.write_text(
|
||||
f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"
|
||||
"n = int(p.read_text()) + 1; p.write_text(str(n))\n"
|
||||
"print('done' if n >= 2 else str(n), end='')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
yaml_str = f"""
|
||||
schema_version: "1.0"
|
||||
workflow:
|
||||
id: "do-while-condition-update"
|
||||
name: "Do While Condition Update"
|
||||
version: "1.0.0"
|
||||
steps:
|
||||
- id: retry-loop
|
||||
type: do-while
|
||||
condition: "{{{{ 'done' not in steps.attempt.output.stdout }}}}"
|
||||
max_iterations: 5
|
||||
steps:
|
||||
- id: attempt
|
||||
type: shell
|
||||
run: '"{py}" "{script_file}"'
|
||||
"""
|
||||
definition = WorkflowDefinition.from_string(yaml_str)
|
||||
engine = WorkflowEngine(project_dir)
|
||||
state = engine.execute(definition)
|
||||
|
||||
assert state.status == RunStatus.COMPLETED
|
||||
assert state.step_results["attempt"]["output"]["stdout"] == "done"
|
||||
assert counter_file.read_text(encoding="utf-8").strip() == "2"
|
||||
|
||||
def test_while_loop_runs_to_max_when_condition_stays_true(self, project_dir):
|
||||
"""While loop must still run to max_iterations when the condition
|
||||
never becomes false — copy-back must not break this path.
|
||||
|
||||
See https://github.com/github/spec-kit/issues/2592
|
||||
"""
|
||||
from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition
|
||||
from specify_cli.workflows.base import RunStatus
|
||||
|
||||
import sys
|
||||
|
||||
counter_file = project_dir / ".counter"
|
||||
counter_file.write_text("0", encoding="utf-8")
|
||||
py = sys.executable
|
||||
script_file = project_dir / "_tick.py"
|
||||
script_file.write_text(
|
||||
f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"
|
||||
"n = int(p.read_text()) + 1; p.write_text(str(n))\n"
|
||||
"print('pending', end='')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
yaml_str = f"""
|
||||
schema_version: "1.0"
|
||||
workflow:
|
||||
id: "while-max-iterations"
|
||||
name: "While Max Iterations"
|
||||
version: "1.0.0"
|
||||
steps:
|
||||
- id: retry-loop
|
||||
type: while
|
||||
condition: "{{{{ 'done' not in steps.tick.output.stdout }}}}"
|
||||
max_iterations: 3
|
||||
steps:
|
||||
- id: tick
|
||||
type: shell
|
||||
run: '"{py}" "{script_file}"'
|
||||
"""
|
||||
definition = WorkflowDefinition.from_string(yaml_str)
|
||||
engine = WorkflowEngine(project_dir)
|
||||
state = engine.execute(definition)
|
||||
|
||||
assert state.status == RunStatus.COMPLETED
|
||||
# All 3 iterations ran (iteration 0 + 2 loop iterations).
|
||||
assert counter_file.read_text(encoding="utf-8").strip() == "3"
|
||||
# Unprefixed key holds the last iteration's result.
|
||||
assert state.step_results["tick"]["output"]["stdout"] == "pending"
|
||||
# Namespaced keys for loop iterations exist.
|
||||
assert "retry-loop:tick:1" in state.step_results
|
||||
assert "retry-loop:tick:2" in state.step_results
|
||||
|
||||
def test_do_while_loop_runs_to_max_when_condition_stays_true(self, project_dir):
|
||||
"""Do-while loop must still run to max_iterations when the condition
|
||||
never becomes false.
|
||||
|
||||
See https://github.com/github/spec-kit/issues/2592
|
||||
"""
|
||||
from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition
|
||||
from specify_cli.workflows.base import RunStatus
|
||||
|
||||
import sys
|
||||
|
||||
counter_file = project_dir / ".counter"
|
||||
counter_file.write_text("0", encoding="utf-8")
|
||||
py = sys.executable
|
||||
script_file = project_dir / "_tick.py"
|
||||
script_file.write_text(
|
||||
f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"
|
||||
"n = int(p.read_text()) + 1; p.write_text(str(n))\n"
|
||||
"print('pending', end='')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
yaml_str = f"""
|
||||
schema_version: "1.0"
|
||||
workflow:
|
||||
id: "do-while-max-iterations"
|
||||
name: "Do While Max Iterations"
|
||||
version: "1.0.0"
|
||||
steps:
|
||||
- id: retry-loop
|
||||
type: do-while
|
||||
condition: "{{{{ 'done' not in steps.tick.output.stdout }}}}"
|
||||
max_iterations: 3
|
||||
steps:
|
||||
- id: tick
|
||||
type: shell
|
||||
run: '"{py}" "{script_file}"'
|
||||
"""
|
||||
definition = WorkflowDefinition.from_string(yaml_str)
|
||||
engine = WorkflowEngine(project_dir)
|
||||
state = engine.execute(definition)
|
||||
|
||||
assert state.status == RunStatus.COMPLETED
|
||||
assert counter_file.read_text(encoding="utf-8").strip() == "3"
|
||||
assert state.step_results["tick"]["output"]["stdout"] == "pending"
|
||||
|
||||
def test_while_loop_multi_step_body_inter_step_refs(self, project_dir):
|
||||
"""Multi-step loop body: step B must see step A's output from the
|
||||
current iteration, not a stale previous one.
|
||||
|
||||
See https://github.com/github/spec-kit/issues/2592
|
||||
"""
|
||||
from specify_cli.workflows.engine import WorkflowEngine, WorkflowDefinition
|
||||
from specify_cli.workflows.base import RunStatus
|
||||
|
||||
import sys
|
||||
|
||||
counter_file = project_dir / ".counter"
|
||||
counter_file.write_text("0", encoding="utf-8")
|
||||
py = sys.executable
|
||||
|
||||
# Step A: increments counter file, echoes the value.
|
||||
step_a_file = project_dir / "_step_a.py"
|
||||
step_a_file.write_text(
|
||||
f"import pathlib; p = pathlib.Path(r'{counter_file}')\n"
|
||||
"n = int(p.read_text()) + 1; p.write_text(str(n))\n"
|
||||
"print(str(n), end='')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
# Step B uses {{ steps.step-a.output.stdout }} expression
|
||||
# substitution in its run command so the engine resolves the
|
||||
# aliased unprefixed key — this is the real inter-step test.
|
||||
yaml_str = f"""
|
||||
schema_version: "1.0"
|
||||
workflow:
|
||||
id: "while-multi-step"
|
||||
name: "While Multi Step"
|
||||
version: "1.0.0"
|
||||
steps:
|
||||
- id: retry-loop
|
||||
type: while
|
||||
condition: "{{{{ 'done' not in steps.step-a.output.stdout }}}}"
|
||||
max_iterations: 3
|
||||
steps:
|
||||
- id: step-a
|
||||
type: shell
|
||||
run: '"{py}" "{step_a_file}"'
|
||||
- id: step-b
|
||||
type: shell
|
||||
run: "echo b-saw-{{{{ steps.step-a.output.stdout }}}}"
|
||||
"""
|
||||
definition = WorkflowDefinition.from_string(yaml_str)
|
||||
engine = WorkflowEngine(project_dir)
|
||||
state = engine.execute(definition)
|
||||
|
||||
assert state.status == RunStatus.COMPLETED
|
||||
# Both unprefixed keys reflect the latest iteration's results.
|
||||
assert state.step_results["step-a"]["output"]["stdout"] == "3"
|
||||
# Step B saw step A's output via expression substitution.
|
||||
assert "b-saw-3" in state.step_results["step-b"]["output"]["stdout"]
|
||||
# Namespaced keys exist for loop iterations.
|
||||
assert "retry-loop:step-a:1" in state.step_results
|
||||
assert "retry-loop:step-b:1" in state.step_results
|
||||
assert "retry-loop:step-a:2" in state.step_results
|
||||
assert "retry-loop:step-b:2" in state.step_results
|
||||
|
||||
|
||||
# ===== State Persistence Tests =====
|
||||
|
||||
|
||||
Reference in New Issue
Block a user