Skip to content

fix: Align native skills frontmatter with install_ai_skills#1920

Open
RbBtSn0w wants to merge 2 commits intogithub:mainfrom
RbBtSn0w:fix/skills-frontmatter-sync
Open

fix: Align native skills frontmatter with install_ai_skills#1920
RbBtSn0w wants to merge 2 commits intogithub:mainfrom
RbBtSn0w:fix/skills-frontmatter-sync

Conversation

@RbBtSn0w
Copy link
Contributor

@RbBtSn0w RbBtSn0w commented Mar 20, 2026

Follow-up to #1906.

Context

  • Spec-kit now supports native skills for some agents (e.g. Codex/Kimi) where the template archive contains prebuilt SKILL.md files.
  • We currently have multiple SKILL.md generators (release packaging, init-time install_ai_skills() conversion, and extension overrides). If their frontmatter contracts drift, we end up with inconsistent skills across agents.

What this PR changes

  • Release packaging scripts: ensure native SKILL.md includes the same minimal frontmatter contract used by install_ai_skills() / extension overrides (adds compatibility and metadata.{author,source}) and adds a short note to keep generators in sync.
  • Docs: update AGENTS.md to reflect Codex’s .agents/skills/ layout.
  • Code comments: document the multi-generator technical debt near NATIVE_SKILLS_AGENTS and render_skill_command().

Impact

  • Affects only release-packaged native skills output (template archives). No change to init-time install_ai_skills() conversion behavior.

Related discussions

Test plan

  • bash -n .github/workflows/scripts/create-release-packages.sh
  • CI will run the Python test suite.

@RbBtSn0w RbBtSn0w requested a review from mnriem as a code owner March 20, 2026 07:47
Copilot AI review requested due to automatic review settings March 20, 2026 07:47
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR reduces “skills drift” by documenting that there are multiple SKILL.md generators in spec-kit and aligning the native (release-packaged) SKILL.md frontmatter shape with the schema used by init-time conversion and extension/preset overrides.

Changes:

  • Document (in code comments) that SKILL.md can be generated via template packaging, install_ai_skills(), and extension/preset overrides, and that frontmatter keys must remain aligned.
  • Update release packaging scripts to include compatibility and metadata (incl. metadata.source) in generated SKILL.md frontmatter.
  • Update AGENTS.md to reflect Codex’s .agents/skills/ convention and invocation pattern.

Reviewed changes

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

Show a summary per file
File Description
src/specify_cli/agents.py Adds a technical-debt note clarifying multi-generator SKILL.md drift risk and schema alignment needs.
src/specify_cli/__init__.py Documents the three SKILL.md generation paths and the minimum frontmatter schema to keep aligned.
AGENTS.md Updates Codex directory convention to .agents/skills/ and clarifies skills invocation.
.github/workflows/scripts/create-release-packages.sh Aligns native SKILL.md frontmatter by adding compatibility and metadata fields.
.github/workflows/scripts/create-release-packages.ps1 Mirrors the shell script’s SKILL.md frontmatter updates in the PowerShell packaging script.

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

@RbBtSn0w RbBtSn0w changed the title Align native skills frontmatter + document multi-generator drift fix:Align native skills frontmatter + document multi-generator drift Mar 20, 2026
@RbBtSn0w RbBtSn0w changed the title fix:Align native skills frontmatter + document multi-generator drift feat: Align native skills frontmatter + document multi-generator drift Mar 20, 2026
@RbBtSn0w RbBtSn0w changed the title feat: Align native skills frontmatter + document multi-generator drift fix: Align native skills frontmatter with install_ai_skills Mar 20, 2026
@mnriem mnriem requested a review from Copilot March 20, 2026 13:22
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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


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

Copy link
Collaborator

@mnriem mnriem left a comment

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

@RbBtSn0w
Copy link
Contributor Author

Addressed Copilot CR feedback:

  • Updated the documented minimum SKILL.md frontmatter contract to include metadata.{author,source} (Python + packaging scripts).
  • Clarified the render_skill_command() drift note to explicitly mention metadata.author and metadata.source.
  • Updated AGENTS.md to move Codex out of the prompt-based exceptions list (now under skills-based exceptions).

Local verification:

  • .venv/bin/python -m pytest -q (435 passed)
  • bash -n .github/workflows/scripts/create-release-packages.sh

@RbBtSn0w
Copy link
Contributor Author

@mnriem Copilot inline suggestions have been addressed and tests pass locally; could you please take another look?

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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


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

@RbBtSn0w RbBtSn0w requested a review from mnriem March 20, 2026 15:02
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