Skip to content

docs(upgrade): document integration upgrade / extension update as the project-files upgrade path#3326

Open
PascalThuet wants to merge 1 commit into
github:mainfrom
PascalThuet:docs/upgrade-project-files-path
Open

docs(upgrade): document integration upgrade / extension update as the project-files upgrade path#3326
PascalThuet wants to merge 1 commit into
github:mainfrom
PascalThuet:docs/upgrade-project-files-path

Conversation

@PascalThuet

@PascalThuet PascalThuet commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Reframe project-file upgrades around the manifest-aware specify integration upgrade <key> flow.
  • Add specify integration status and specify extension update to the documented upgrade path.
  • Keep specify init --here --force --integration <your-agent> documented as a fallback recovery path.
  • Replace the old constitution backup/restore guidance with the current behavior: existing .specify/memory/constitution.md is preserved, while missing constitution files are created from the template.
  • Update common upgrade scenarios and troubleshooting so they no longer present full re-init as the routine project update path.

Why

The upgrade guide currently sends existing projects through specify init --here --force, even though installed integrations now have manifests that can detect modified managed files and block unsafe overwrites unless --force is explicit. Projects with multiple integrations or installed extensions also need guidance to refresh each installed integration and then update extensions.

Validation

  • git diff --check
  • npx markdownlint-cli2 docs/upgrade.md

AI Disclosure

This PR was prepared by OpenAI Codex (model: GPT-5) acting as an AI coding agent on behalf of @PascalThuet.

@PascalThuet PascalThuet force-pushed the docs/upgrade-project-files-path branch from 51f9b1c to 34f1774 Compare July 3, 2026 21:48
@PascalThuet PascalThuet changed the title docs: document manifest-aware project upgrades docs(upgrade): document integration upgrade / extension update as the project-files upgrade path Jul 3, 2026
@PascalThuet PascalThuet marked this pull request as ready for review July 3, 2026 21:50
@PascalThuet PascalThuet requested a review from mnriem as a code owner July 3, 2026 21:50
Assisted-by: OpenAI Codex (model: GPT-5, autonomous)
@PascalThuet PascalThuet force-pushed the docs/upgrade-project-files-path branch from 34f1774 to 29f29a8 Compare July 4, 2026 05:53
@PascalThuet PascalThuet marked this pull request as draft July 4, 2026 05:57
@PascalThuet PascalThuet marked this pull request as ready for review July 4, 2026 06:23
@mnriem mnriem requested a review from Copilot July 6, 2026 14:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the upgrade guide to prioritize the manifest-aware project refresh workflow (integrations + extensions) over full re-init, aligning documentation with the current integration/extension management model in Spec Kit.

Changes:

  • Reframes project updates around specify integration status + specify integration upgrade <key> as the primary upgrade path.
  • Adds specify extension update to the documented project upgrade flow.
  • Updates constitution guidance to reflect current behavior (preserve existing; only create from template when missing), keeping specify init --here --force --integration … as a fallback.
Show a summary per file
File Description
docs/upgrade.md Rewrites the project upgrade instructions to use integration manifests and extension updates, with updated safety/warnings and scenarios.

Review details

Tip

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

  • Files reviewed: 1/1 changed files
  • Comments generated: 2
  • Review effort level: Low

Comment thread docs/upgrade.md
| **CLI Tool — manual fallback** | `uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git@vX.Y.Z` | When `specify self upgrade` isn't available (older installs) or when you want explicit control. |
| **CLI Tool — manual fallback (pipx)** | `pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z` | Same as above, for pipx installs. |
| **Project Files** | `specify init --here --force --integration <your-agent>` | Update slash commands, templates, and scripts in your project |
| **Project Files** | `specify integration upgrade <key>` + `specify extension update` | Refresh installed integration files and extensions in your project |
Comment thread docs/upgrade.md
```

### 1. Constitution file will be overwritten
With no extension name, this updates all installed extensions. Use `specify extension update <name>` to update only one extension. See the [extensions reference](reference/extensions.md#update-extensions) for details.

@mnriem mnriem left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants