[Feature]: Add deterministic contribution IDs and stack lookup IDs for resolved artifacts
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 38/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- python
- Lĩnh vực
- cli, documentation, testing, tooling
Hướng nghiên cứu
Bắt đầu với schema và việc xác thực extension manifest, sau đó theo dõi cách PresetResolver xử lý composition cho các layer được provenance hỗ trợ. Đọc extensions/EXTENSION-API-REFERENCE.md và tài liệu tham chiếu về preset API/manifest, đồng thời chạy các bài test schema và resolver hiện có. Được xem là hoàn tất khi các ID xác định và các mối quan hệ lookupId được bao phủ cho tất cả các loại artifact được liệt kê, hook, built-in, override và các trường hợp tương thích.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem Statement
Spec Kit identifies contributed commands, templates, scripts, and hooks primarily by name. Names can collide across artifact kinds and source layers, and a name alone cannot reliably link a resolved artifact-stack layer to the exact manifest contribution that supplied it. Consumers such as preset info --json, extension info --json, and specify artifact need stable contribution identifiers and a join key that works across reinstalls and machines.
Proposed Solution
Introduce computed, opaque id fields for every command, template, script, and hook returned by public preset/extension manifest and info APIs, plus a lookupId field on every provenance-backed non-built-in resolved artifact-stack layer.
For named preset, extension, and project-override contributions, derive IDs using:
{layer}:{sourceId}:{kind}:{name}
Use project, preset, or extension for layer; _ only for the project-override source ID; and the preset or extension manifest ID for manifest-declared sources. Use command, template, or script for kind. Examples include preset:speckit.core:command:speckit.plan, extension:speckit.git:template:pr-body, and project:_:template:spec-template.
For hooks, use {eventName}:{command} as the name component. Hooks are valid only for preset and extension layers. If duplicate event/command hook entries are valid, add an appropriate stable discriminator or reject duplicates; do not use array position.
Built-in artifacts do not have an originating manifest contribution and therefore do not receive a contribution lookupId. Every artifact, including built-ins, instead has a source-agnostic public ID of the form {kind}:{name}. Built-in stack rows are recognized by absent provenance fields (layer, sourceId, and lookupId are null), and round-trip through the public artifact ID.
Compute IDs at read, serialization, or resolution time rather than persisting them in authored or installed manifests. For manifest-declared preset and extension layers, lookupId must exactly match the originating contribution's id. Preserve existing name-based behavior and document IDs as opaque strings.
Alternatives Considered
Install-time UUIDs are unsuitable because they differ across machines and reinstalls. Existing names are insufficient because they collide across sources and kinds. Content hashes are unsuitable because IDs would change whenever artifact content is edited. Array indexes are unsuitable for hooks because reordering entries would change their IDs.
A synthetic core:_:... contribution ID was considered for built-in assets. It was rejected because built-ins have no originating preset or extension manifest contribution to join to; the source-agnostic {kind}:{name} artifact ID provides their stable round-trip key without overloading lookupId.
Do not use the existing integration manifest as the ID source; it tracks installed file hashes and paths rather than manifest contribution identity.
Component
Specify CLI (initialization, commands)
AI Agent (if applicable)
No response
Use Cases
- A wizard can read an artifact stack and follow each provenance-backed layer's
lookupIdto the full contribution detail without re-parsing manifests. - Developers on different machines can use identical IDs when reporting or diagnosing a contribution.
- Tooling can hash or cache resolved compositions using public artifact IDs plus the available layer
lookupIdvalues. - Future JSON output for
preset info,extension info, andspecify artifactcan expose consistent cross-references.
Acceptance Criteria
- Document the
layer:sourceId:kind:namecontribution grammar, the source-agnostickind:nameartifact ID, and thelookupIdrelationship inextensions/EXTENSION-API-REFERENCE.mdand the preset API/manifest reference. - Public preset/extension manifest and info representations expose computed
idvalues for commands, templates, scripts, and hooks. - Hook IDs are deterministic and collision-free without install paths or list indexes.
- Manifest-declared preset and extension artifact-stack layers expose
lookupIdequal to the corresponding contribution'sid. - Project-local override layers use the synthetic
project:_:{kind}:{name}lookup form and intentionally have no manifest contribution match. - Built-in artifact-stack layers expose no contribution provenance (
layer,sourceId, andlookupIdare null) and round-trip through the public{kind}:{name}artifact ID. - Identical manifest coordinates produce identical IDs across processes, machines, project locations, and reinstalls.
- Manifest-backed IDs do not depend on artifact contents, timestamps, manifest hashes, archive paths, or installation directories.
- Existing
namefields and name-based resolution remain unchanged. - Tests cover each provenance-backed layer and artifact kind, hook uniqueness, resolver repeatability, manifest lookup round-trips, built-in public-ID round-trips, and backward compatibility.
Additional Context
This request defines the ID contract only. Adding the JSON output surfaces themselves for preset info --json, extension info --json, or specify artifact is out of scope and will be handled separately. Changing precedence, resolution, installation, or uninstall behavior is also out of scope. Relevant implementation areas include the extension manifest schema and validation and PresetResolver composition handling. IDs must not expose install paths, secrets, or connection strings.
- Ngôn ngữ chính
- Python
- Star
- 138k
- Fork
- 12.4k
- Merge trung bình
- 3 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 169
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/spec-kit
-
enhancement needs-triage triage-can-wait
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
preset-submission triage-must-have validation-passed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
extension-submission triage-must-have validation-passed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
extension-submission triage-can-wait validation-passed
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
[Feature]: 给 slug 添加默认值 Đang mởenhancement needs-triage triage-can-wait
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Tất cả issue của github/spec-kit
Issue tương tự
-
agent-ready documentation needs-triage
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
-
Add https://search.jeremyh.xyz/ Đang mởinstance instance add
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
searxng/searx-instances#939 · 1 bình luận ·
-
area-deployment area-integrations triage:bot-seen
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 86/100