Skip to content

Move breaking-change-doc scripts into scripts/ and use bare skill-relative paths#127977

Open
lewing wants to merge 2 commits intodotnet:mainfrom
lewing:move-breaking-change-doc-scripts
Open

Move breaking-change-doc scripts into scripts/ and use bare skill-relative paths#127977
lewing wants to merge 2 commits intodotnet:mainfrom
lewing:move-breaking-change-doc-scripts

Conversation

@lewing
Copy link
Copy Markdown
Member

@lewing lewing commented May 8, 2026

Aligns the breaking-change-doc skill with the agentskills.io spec:

  1. Move scripts into scripts/ subdirectory (the spec's recommended layout).
  2. Use bare skill-relative paths (scripts/Get-VersionInfo.ps1) in the two pwsh invocation examples in SKILL.md, to match the sample in the spec.
.github/skills/breaking-change-doc/SKILL.md                             | 8 ++++----
.github/skills/breaking-change-doc/{ => scripts}/Build-IssueComment.ps1 | 2 +-
.github/skills/breaking-change-doc/{ => scripts}/Get-VersionInfo.ps1    | 2 +-

The "files in this skill" table at lines 46-48 keeps its repo-relative paths because it also lists files outside the skill (the workflow .md and .lock.yml), and mixing styles in one table would be jarring.

No behavioral change; pure path/layout updates.

Aligns the breaking-change-doc skill with the agentskills.io
recommended layout: executable code goes in scripts/, not at the
skill root.

  Get-VersionInfo.ps1   -> scripts/Get-VersionInfo.ps1
  Build-IssueComment.ps1 -> scripts/Build-IssueComment.ps1

Updated all references:
- 4 invocation paths in SKILL.md
- 1 usage example comment in each script (2 total)

Pure file moves preserved via git mv (similarity 100% before the
in-script comment edit). No behavioral change.
Copilot AI review requested due to automatic review settings May 8, 2026 22:53
@github-actions github-actions Bot added the area-skills Agent Skills label May 8, 2026
Copy link
Copy Markdown
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 reorganizes the breaking-change-doc GitHub skill to follow the conventional scripts/ layout by moving the two PowerShell helper scripts under a scripts/ subdirectory and updating all in-repo references accordingly.

Changes:

  • Relocated Get-VersionInfo.ps1 and Build-IssueComment.ps1 into .github/skills/breaking-change-doc/scripts/.
  • Updated invocation paths in SKILL.md to reference the new scripts/ locations.
  • Updated the usage-example header comments inside both scripts to match the new paths.

Reviewed changes

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

File Description
.github/skills/breaking-change-doc/SKILL.md Updates documentation and command examples to use the new scripts/ paths.
.github/skills/breaking-change-doc/scripts/Get-VersionInfo.ps1 Updates the header usage example to the new script location (no functional change).
.github/skills/breaking-change-doc/scripts/Build-IssueComment.ps1 Updates the header usage example to the new script location (no functional change).

The agentskills.io spec shows skill-relative paths (e.g. scripts/foo.py)
rather than repo-relative ones. Switch the two pwsh invocation examples
in SKILL.md to that form. The 'files in this skill' table on lines 46-48
keeps repo-relative paths because it also lists files outside the skill
(workflow files), and mixing styles in one table would be jarring.
@lewing lewing changed the title Move breaking-change-doc scripts into scripts/ subdirectory Move breaking-change-doc scripts into scripts/ and use bare skill-relative paths May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-skills Agent Skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants