Update for better maintainability by localden · Pull Request #406 · github/spec-kit

localden · 2025-09-20T18:20:24Z

Updates that make general QOL improvements for better project maintainability.

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

into consolidate-scripts

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-21T04:44:12Z

 5. **Update agent file incrementally** (O(1) operation):
-   - Run `{SCRIPT}` for your AI assistant
+   - Run `{SCRIPT}`
+     **IMPORTANT**: Execute it exactly as specified above. Do not add or remove any arguments.


The instruction 'Execute it exactly as specified above' refers to something that isn't actually specified in the visible context. This could be confusing since there's no specific execution command shown above this line.

Suggested change

**IMPORTANT**: Execute it exactly as specified above. Do not add or remove any arguments.

**IMPORTANT**: When the actual script command is provided, execute it exactly as shown, without adding or removing any arguments.

Copilot · 2025-09-21T04:44:13Z

+    grep "^\*\*${field_pattern}\*\*: " "$plan_file" 2>/dev/null | \
        head -1 | \
-        sed "s/^**${field_pattern}**: //" | \
+        sed "s|^\*\*${field_pattern}\*\*: ||" | \
+        sed 's/^[ \t]*//;s/[ \t]*$//' | \


[nitpick] The regex pattern uses escaped asterisks \*\* which creates unnecessary complexity. Consider using a more readable approach or add a comment explaining why the asterisks need to be escaped in this context.

Copilot · 2025-09-21T04:44:13Z

+            if [[ -d "$dir" ]]; then
+                local dirname=$(basename "$dir")
+                if [[ "$dirname" =~ ^([0-9]{3})- ]]; then
+                    local number=${BASH_REMATCH[1]}


[nitpick] The arithmetic expansion $((10#$number)) forces base-10 interpretation to handle potential leading zeros, but this could be clearer with a comment explaining why this is necessary for proper numeric comparison.

Suggested change

local number=${BASH_REMATCH[1]}

local number=${BASH_REMATCH[1]}

# Force base-10 interpretation to handle leading zeros (e.g., "007" -> 7)

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-21T07:53:35Z

+        sed "s|^\*\*${field_pattern}\*\*: ||" | \
+        sed 's/^[ \t]*//;s/[ \t]*$//' | \


Multiple sed calls can be combined into a single sed command for better performance. Consider using: sed 's|^**'"$field_pattern"'**: ||; s/^[ \t]//; s/[ \t]$//' for improved efficiency.

Suggested change

sed "s|^\*\*${field_pattern}\*\*: ||" | \

sed 's/^[ \t]*//;s/[ \t]*$//' | \

sed "s|^\*\*${field_pattern}\*\*: ||;s/^[ \t]*//;s/[ \t]*$//" | \

Copilot · 2025-09-21T07:53:35Z

+    $regex = "^\*\*$([Regex]::Escape($FieldPattern))\*\*: (.+)$"
+    Get-Content -LiteralPath $PlanFile | ForEach-Object {
+        if ($_ -match $regex) { 
+            $val = $Matches[1].Trim()


The regex uses $Matches[1] but the capture group is actually the second group (index 1). However, the intended capture should be $Matches[2] since the first group is the escaped field pattern and the second group (.+) contains the actual value.

Suggested change

$val = $Matches[1].Trim()

$val = $Matches[2].Trim()

Copilot · 2025-09-21T07:53:36Z

 if [ -f "$TEMPLATE" ]; then cp "$TEMPLATE" "$SPEC_FILE"; else touch "$SPEC_FILE"; fi

+# Set the SPECIFY_FEATURE environment variable for the current session
+export SPECIFY_FEATURE="$BRANCH_NAME"


The export statement only affects the current script's environment. Consider documenting that users need to manually export this variable in their shell session, or provide instructions for persistent environment variable setup.

Copilot · 2025-09-21T07:53:36Z

@@ -158,11 +161,11 @@ build_variant() {
      mkdir -p "$base_dir/.windsurf/workflows"
      generate_commands windsurf md "\$ARGUMENTS" "$base_dir/.windsurf/workflows" "$script" ;;
    codex)


[nitpick] The path change from '.codex/commands' to '.codex/prompts' should be documented in the commit message or comments, as this represents a breaking change for existing Codex integrations.

Suggested change

codex)

codex)

# BREAKING CHANGE: Codex integration path changed from '.codex/commands' to '.codex/prompts'.

# Existing Codex integrations expecting '.codex/commands' will need to be updated.

Copilot

Pull Request Overview

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

Comments suppressed due to low confidence (1)

scripts/bash/check-prerequisites.sh:1

Line 62 contains PowerShell syntax in a bash script. The variable assignment should use bash syntax: has_git=$(test -d \"$REPO_ROOT/.git\" && echo \"true\" || echo \"false\")

#!/usr/bin/env bash

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Copilot

Pull Request Overview

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

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-21T08:49:36Z

+param(
+    [Parameter(Position=0)]
+    [ValidateSet('claude','gemini','copilot','cursor','qwen','opencode','codex','windsurf')]


[nitpick] The ValidateSet attribute should be consistent across all scripts. Consider defining this list as a constant or shared variable to ensure consistency and easier maintenance when adding new agents.

Suggested change

param(

[Parameter(Position=0)]

[ValidateSet('claude','gemini','copilot','cursor','qwen','opencode','codex','windsurf')]

# Define agent types as a constant array for consistency

$AGENT_TYPES = @('claude','gemini','copilot','cursor','qwen','opencode','codex','windsurf')

param(

[Parameter(Position=0)]

[ValidateSet($AGENT_TYPES)]

Copilot · 2025-09-21T08:49:37Z

+    check_file "$RESEARCH" "research.md"
+    check_file "$DATA_MODEL" "data-model.md"
+    check_dir "$CONTRACTS_DIR" "contracts/"
+    check_file "$QUICKSTART" "quickstart.md"


The check_file and check_dir functions are being called but are not defined in this script. These functions need to be defined or sourced from common.sh.

Copilot · 2025-09-21T08:49:37Z

+    Test-FileExists -Path $paths.RESEARCH -Description 'research.md' | Out-Null
+    Test-FileExists -Path $paths.DATA_MODEL -Description 'data-model.md' | Out-Null
+    Test-DirHasFiles -Path $paths.CONTRACTS_DIR -Description 'contracts/' | Out-Null
+    Test-FileExists -Path $paths.QUICKSTART -Description 'quickstart.md' | Out-Null
+
+    if ($IncludeTasks) {
+        Test-FileExists -Path $paths.TASKS -Description 'tasks.md' | Out-Null


The functions Test-FileExists and Test-DirHasFiles are being called but are not defined in this script or imported from common.ps1. These functions need to be defined or the calls should be replaced with appropriate PowerShell equivalents.

Suggested change

Test-FileExists -Path $paths.RESEARCH -Description 'research.md' | Out-Null

Test-FileExists -Path $paths.DATA_MODEL -Description 'data-model.md' | Out-Null

Test-DirHasFiles -Path $paths.CONTRACTS_DIR -Description 'contracts/' | Out-Null

Test-FileExists -Path $paths.QUICKSTART -Description 'quickstart.md' | Out-Null

if ($IncludeTasks) {

Test-FileExists -Path $paths.TASKS -Description 'tasks.md' | Out-Null

if (Test-Path $paths.RESEARCH) {

Write-Output " [x] research.md"

} else {

Write-Output " [ ] research.md (missing)"

}

if (Test-Path $paths.DATA_MODEL) {

Write-Output " [x] data-model.md"

} else {

Write-Output " [ ] data-model.md (missing)"

}

if ((Test-Path $paths.CONTRACTS_DIR) -and (Get-ChildItem -Path $paths.CONTRACTS_DIR -File -ErrorAction SilentlyContinue | Select-Object -First 1)) {

Write-Output " [x] contracts/"

} else {

Write-Output " [ ] contracts/ (missing or empty)"

}

if (Test-Path $paths.QUICKSTART) {

Write-Output " [x] quickstart.md"

} else {

Write-Output " [ ] quickstart.md (missing)"

}

if ($IncludeTasks) {

if (Test-Path $paths.TASKS) {

Write-Output " [x] tasks.md"

} else {

Write-Output " [ ] tasks.md (missing)"

}

Copilot · 2025-09-21T08:49:37Z

+      mkdir -p "$base_dir/.codex/prompts"
+      generate_commands codex md "\$ARGUMENTS" "$base_dir/.codex/prompts" "$script" ;;
  esac


[nitpick] The directory structure for Codex has changed from .codex/commands to .codex/prompts but this change should be documented or commented to explain why the directory structure differs from other agents.

Suggested change

mkdir -p "$base_dir/.codex/prompts"

generate_commands codex md "\$ARGUMENTS" "$base_dir/.codex/prompts" "$script" ;;

esac

# Note: Codex uses `.codex/prompts` instead of `.codex/commands` to match its expected directory structure.

# This differs from other agents, which use a `commands` subdirectory. See Codex integration docs for details.

mkdir -p "$base_dir/.codex/prompts"

generate_commands codex md "\$ARGUMENTS" "$base_dir/.codex/prompts" "$script" ;;

Update for better maintainability

Consolidate scripts

7c0f0a4

Copilot AI review requested due to automatic review settings September 20, 2025 18:20

This comment was marked as outdated.

Sign in to view

localden added 2 commits September 20, 2025 11:38

Use proper line endings

64171ec

Cleanup the setup for generated packages

aa08257

Copilot AI review requested due to automatic review settings September 20, 2025 18:52

This comment was marked as outdated.

Sign in to view

localden and others added 2 commits September 20, 2025 11:57

Update script delegation from GitHub Action

e83e1cd

Update scripts/powershell/check-prerequisites.ps1

826c3a6

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

Copilot AI review requested due to automatic review settings September 20, 2025 19:01

Update scripts/bash/check-prerequisites.sh

0bebcf9

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

This comment was marked as outdated.

Sign in to view

localden added 2 commits September 20, 2025 12:14

Script cleanup

505b956

Fix script path

3f67cf2

Copilot AI review requested due to automatic review settings September 20, 2025 19:27

This comment was marked as outdated.

Sign in to view

Update scripts/bash/check-prerequisites.sh

2c1e168

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

Copilot AI review requested due to automatic review settings September 20, 2025 20:56

Update scripts/powershell/check-prerequisites.ps1

84ec461

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

This comment was marked as outdated.

Sign in to view

localden added 3 commits September 20, 2025 13:57

Update config

2d242b4

Merge branch 'consolidate-scripts' of https://github.com/github/spec-kit

f04e01d

into consolidate-scripts

Script and template tweaks

1a71b03

Copilot AI review requested due to automatic review settings September 20, 2025 22:04

Copilot AI reviewed Sep 20, 2025

View reviewed changes

Comment thread templates/plan-template.md Outdated

Comment thread scripts/bash/update-agent-context.sh Outdated

Comment thread scripts/bash/create-new-feature.sh Outdated

Comment thread scripts/powershell/create-new-feature.ps1 Outdated

localden and others added 2 commits September 20, 2025 15:29

Simplification

406521c

Update scripts/powershell/create-new-feature.ps1

8d52959

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

Copilot AI review requested due to automatic review settings September 21, 2025 02:54

localden and others added 2 commits September 20, 2025 19:54

Update scripts/bash/update-agent-context.sh

4cc15ba

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

Update templates/plan-template.md

0e5f7ce

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

Copilot AI review requested due to automatic review settings September 21, 2025 04:43

Copilot AI reviewed Sep 21, 2025

View reviewed changes

localden added 2 commits September 20, 2025 23:38

Update update-agent-context.ps1

90f0652

Update prompts

895bcbe

Copilot AI review requested due to automatic review settings September 21, 2025 07:02

Copilot AI reviewed Sep 21, 2025

View reviewed changes

localden and others added 2 commits September 21, 2025 00:44

Clarification

d682f5a

Update scripts/powershell/update-agent-context.ps1

0672bfc

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

Copilot AI review requested due to automatic review settings September 21, 2025 07:45

localden and others added 2 commits September 21, 2025 00:45

Update scripts/powershell/update-agent-context.ps1

84b61bc

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

Update scripts/bash/common.sh

da60d35

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

Copilot AI reviewed Sep 21, 2025

View reviewed changes

Comment thread scripts/powershell/update-agent-context.ps1

Comment thread scripts/bash/update-agent-context.sh Outdated

Comment thread src/specify_cli/__init__.py

localden and others added 2 commits September 21, 2025 00:51

Fix script config

93e4156

Update scripts/bash/update-agent-context.sh

0e49e79

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

Copilot AI review requested due to automatic review settings September 21, 2025 07:52

Copilot AI reviewed Sep 21, 2025

View reviewed changes

localden added 2 commits September 21, 2025 01:28

Update changelog

5243137

Update CHANGELOG.md

a810b1b

Copilot AI review requested due to automatic review settings September 21, 2025 08:28

Update CHANGELOG.md

2d89075

Copilot AI reviewed Sep 21, 2025

View reviewed changes

Comment thread scripts/powershell/check-prerequisites.ps1 Outdated

Comment thread .github/workflows/scripts/create-release-packages.sh

Update scripts/powershell/check-prerequisites.ps1

b03bba3

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

Copilot AI review requested due to automatic review settings September 21, 2025 08:48

localden merged commit 1a84b4b into main Sep 21, 2025
2 checks passed

Copilot AI reviewed Sep 21, 2025

View reviewed changes

jellydn pushed a commit to jellydn/spec-kit that referenced this pull request Sep 30, 2025

Merge pull request github#406 from github/consolidate-scripts

5e9e931

Update for better maintainability

francovp mentioned this pull request Oct 29, 2025

Fix: Release script missing agent template files in package creation #420

Closed

mnriem deleted the consolidate-scripts branch February 18, 2026 22:57

TheChrisHatfield pushed a commit to TheChrisHatfield/spec-kit that referenced this pull request Aug 30, 2026

Merge pull request github#406 from github/consolidate-scripts

e534bd8

Update for better maintainability

raccioly mentioned this pull request Sep 17, 2026

[Extension]: Update DocGuard — CDD Enforcement (v0.41.6) #4590

Closed

11 tasks

	IMPORTANT: Execute it exactly as specified above. Do not add or remove any arguments.
	IMPORTANT: When the actual script command is provided, execute it exactly as shown, without adding or removing any arguments.

	local number=${BASH_REMATCH[1]}
	local number=${BASH_REMATCH[1]}
	# Force base-10 interpretation to handle leading zeros (e.g., "007" -> 7)

		sed "s\|^\\${field_pattern}\\: \|\|" \| \
		sed 's/^[ \t]//;s/[ \t]$//' \| \

	sed "s\|^\\${field_pattern}\\: \|\|" \| \
	sed 's/^[ \t]//;s/[ \t]$//' \| \
	sed "s\|^\\${field_pattern}\\: \|\|;s/^[ \t]//;s/[ \t]$//" \| \

-    codex)
+    codex)
+      # BREAKING CHANGE: Codex integration path changed from '.codex/commands' to '.codex/prompts'.
+      # Existing Codex integrations expecting '.codex/commands' will need to be updated.

-    Test-FileExists -Path $paths.RESEARCH -Description 'research.md' | Out-Null
-    Test-FileExists -Path $paths.DATA_MODEL -Description 'data-model.md' | Out-Null
-    Test-DirHasFiles -Path $paths.CONTRACTS_DIR -Description 'contracts/' | Out-Null
-    Test-FileExists -Path $paths.QUICKSTART -Description 'quickstart.md' | Out-Null
-    if ($IncludeTasks) {
-        Test-FileExists -Path $paths.TASKS -Description 'tasks.md' | Out-Null
+    if (Test-Path $paths.RESEARCH) {
+        Write-Output "  [x] research.md"
+    } else {
+        Write-Output "  [ ] research.md (missing)"
+    }
+    if (Test-Path $paths.DATA_MODEL) {
+        Write-Output "  [x] data-model.md"
+    } else {
+        Write-Output "  [ ] data-model.md (missing)"
+    }
+    if ((Test-Path $paths.CONTRACTS_DIR) -and (Get-ChildItem -Path $paths.CONTRACTS_DIR -File -ErrorAction SilentlyContinue | Select-Object -First 1)) {
+        Write-Output "  [x] contracts/"
+    } else {
+        Write-Output "  [ ] contracts/ (missing or empty)"
+    }
+    if (Test-Path $paths.QUICKSTART) {
+        Write-Output "  [x] quickstart.md"
+    } else {
+        Write-Output "  [ ] quickstart.md (missing)"
+    }
+    if ($IncludeTasks) {
+        if (Test-Path $paths.TASKS) {
+            Write-Output "  [x] tasks.md"
+        } else {
+            Write-Output "  [ ] tasks.md (missing)"
+        }

Conversation

localden commented Sep 20, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 21, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 21, 2025