Sync eng/common directory with azure-sdk-tools for PR 15062#48774
Open
Sync eng/common directory with azure-sdk-tools for PR 15062#48774
Conversation
Rename 5 shared skills to use the azsdk-common- prefix so the sync-.github.yml pipeline can pattern-match and distribute them to all subscribed Azure SDK language repos. Renames: generate-sdk-locally → azsdk-common-generate-sdk-locally apiview-feedback-resolution → azsdk-common-apiview-feedback-resolution pipeline-troubleshooting → azsdk-common-pipeline-troubleshooting prepare-release-plan → azsdk-common-prepare-release-plan sdk-release → azsdk-common-sdk-release Updated: - SKILL.md name: fields in all 5 skills - All eval.yaml and trigger_tests.yaml skill/name references - .github/skills/README.md links and naming convention docs - sensei SKILL.md example reference - 8 instruction files in eng/common/instructions/azsdk-tools/ with Related Skill cross-references pointing to new skill paths - copilot/sdk-release.instructions.md with skill cross-reference Relates to #15049 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Changes based on semantic analysis of skill/instruction purpose alignment: - check-package-validation: Remove incorrect related_skill reference to generate-sdk-locally. Validation is a narrow sub-step; pointing users at the full generation workflow is misleading. Added redundancy note instead. - typespec-to-sdk: Add missing pipeline-troubleshooting and apiview-feedback-resolution skills to the orchestrator. This is the entry point where users discover their options after TypeSpec work is merged — all journey skills should be discoverable here. Also added inline references at the exact workflow steps where those skills apply. - create-release-plan: Add missing frontmatter with related_skill (had blockquote but no structured metadata). - copilot/sdk-release: Add missing frontmatter with related_skill (had blockquote but no structured metadata). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Delete 7 instruction files whose content is now fully covered by skills: - local-sdk-workflow.instructions.md → azsdk-common-generate-sdk-locally - create-release-plan.instructions.md → azsdk-common-prepare-release-plan - sdk-details-in-release-plan.instructions.md → azsdk-common-prepare-release-plan - verify-namespace-approval.instructions.md → azsdk-common-prepare-release-plan - check-package-readiness.instructions.md → azsdk-common-sdk-release - check-package-validation.instructions.md → azsdk-common-generate-sdk-locally - copilot/sdk-release.instructions.md → azsdk-common-sdk-release Skills updated with all unique details from instruction files: - generate-sdk-locally: added commit checkpoints, language selection, config file identification, SDK project path, metadata update tools - prepare-release-plan: added critical LLM instructions (NextSteps field), Release Planner Tool link, package name extraction rules per language, valid/invalid examples table, JSON structure, namespace approval flow - sdk-release: added readiness check details, interaction flow pattern, do-not-ask-for-PR/plan guard, case-sensitive language note typespec-to-sdk orchestrator updated to reference skills directly. Removed all related_skill frontmatter and blockquotes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
azure-sdk
added
EngSys
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs eng/common instruction content with updates from azure-sdk-tools PR 15062, primarily by removing older Copilot/azsdk-tools instruction prompts and updating the remaining TypeSpec SDK-generation guidance to point to newer “skills”-based workflows.
Changes:
- Removed multiple legacy instruction prompt files under
eng/common/instructions/{copilot,azsdk-tools}. - Updated
typespec-to-sdk.instructions.mdto reference new skills-based instructions and troubleshooting steps. - Minor front-matter formatting adjustment in
typespec-to-sdk.instructions.md.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| eng/common/instructions/copilot/sdk-release.instructions.md | Removed legacy SDK release instruction prompt. |
| eng/common/instructions/azsdk-tools/verify-namespace-approval.instructions.md | Removed legacy management-plane namespace approval instruction prompt. |
| eng/common/instructions/azsdk-tools/sdk-details-in-release-plan.instructions.md | Removed legacy “add SDK details to release plan” instruction prompt. |
| eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md | Removed legacy local TypeSpec-to-SDK generation workflow prompt. |
| eng/common/instructions/azsdk-tools/create-release-plan.instructions.md | Removed legacy release plan creation prompt. |
| eng/common/instructions/azsdk-tools/check-package-validation.instructions.md | Removed legacy package validation instruction prompt. |
| eng/common/instructions/azsdk-tools/check-package-readiness.instructions.md | Removed legacy package readiness instruction prompt. |
| eng/common/instructions/azsdk-tools/typespec-to-sdk.instructions.md | Updated guidance to reference skills-based files/skills for local generation and release plan creation. |
| **Message to user**: "Generating SDKs locally requires you to have the development environment set up for each language. Prompt the user to create a pull request for each language after completing the following steps successfully: generation, validation, build, test and update of metadata, change log, and version." | ||
| **Actions**: | ||
| Follow the steps in #file:local-sdk-workflow.instructions.md to generate and build SDKs locally from TypeSpec project. | ||
| Follow the steps in #file:.github/skills/azsdk-common-generate-sdk-locally/SKILL.md to generate and build SDKs locally from TypeSpec project. |
There was a problem hiding this comment.
The referenced skill file #file:.github/skills/azsdk-common-generate-sdk-locally/SKILL.md does not exist in this repo (no .github/skills directory). This makes the local-generation path in these instructions a dead link. Update the reference to an existing file/path or add the missing skill content as part of this sync.
Suggested change
| Follow the steps in #file:.github/skills/azsdk-common-generate-sdk-locally/SKILL.md to generate and build SDKs locally from TypeSpec project. | |
| Follow the steps in #file:../eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md to generate and build SDKs locally from TypeSpec project. |
Comment on lines
+55
to
+56
| 3. Display generated SDK PR links when available. If pipeline fails, inform user with error details and suggest to check pipeline logs for more information. Use the `azsdk-common-pipeline-troubleshooting` skill to diagnose and resolve pipeline failures. | ||
| 4. If SDK pull request is available for all languages, ask user to review generated SDK pull request and mark them as ready for review when they are ready to get them reviewed and merged. If APIView feedback is received, use the `azsdk-common-apiview-feedback-resolution` skill to analyze and resolve review comments. |
There was a problem hiding this comment.
These steps reference azsdk-common-pipeline-troubleshooting and azsdk-common-apiview-feedback-resolution as “skills”, but there are no corresponding skill definitions/files in this repo. If these are meant to be repository-local skills, add them (or link them via #file: to existing docs). If they are external capabilities, consider clarifying where they live so the guidance is actionable.
Suggested change
| 3. Display generated SDK PR links when available. If pipeline fails, inform user with error details and suggest to check pipeline logs for more information. Use the `azsdk-common-pipeline-troubleshooting` skill to diagnose and resolve pipeline failures. | |
| 4. If SDK pull request is available for all languages, ask user to review generated SDK pull request and mark them as ready for review when they are ready to get them reviewed and merged. If APIView feedback is received, use the `azsdk-common-apiview-feedback-resolution` skill to analyze and resolve review comments. | |
| 3. Display generated SDK PR links when available. If pipeline fails, inform user with error details and direct them to review the failed stage, job, and task logs for the affected language. Summarize the likely failure point, identify whether the issue is caused by generation, validation, or publishing steps, and suggest the next corrective action before retrying the pipeline. | |
| 4. If SDK pull request is available for all languages, ask user to review generated SDK pull request and mark them as ready for review when they are ready to get them reviewed and merged. If APIView feedback is received, analyze each review comment, map it to the affected generated SDK change, and help the user resolve the feedback by updating code, tests, samples, or documentation as needed before requesting another review. |
| 4. If unsure, check if a release plan already exists for API spec pull request. | ||
| 5. Prompt user to find the service id and product id in service tree `aka.ms/st` and provide them. Stress the importance of correct service id and product id for proper release plan creation. | ||
| 6. If a new release plan is needed, refer to #file:create-release-plan.instructions.md to create a release plan using the spec pull request. API spec pull request is required to create a release plan. | ||
| 6. If a new release plan is needed, refer to #file:.github/skills/azsdk-common-prepare-release-plan/SKILL.md to create a release plan using the spec pull request. API spec pull request is required to create a release plan. |
There was a problem hiding this comment.
The release plan step now points to #file:.github/skills/azsdk-common-prepare-release-plan/SKILL.md, but .github/skills isn’t present in this repo. Also, this PR deletes eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md and eng/common/instructions/copilot/sdk-release.instructions.md, which are still referenced by .github/copilot-instructions.md, leaving dead links. Please update callers/links to the new canonical location as part of this sync.
Suggested change
| 6. If a new release plan is needed, refer to #file:.github/skills/azsdk-common-prepare-release-plan/SKILL.md to create a release plan using the spec pull request. API spec pull request is required to create a release plan. | |
| 6. If a new release plan is needed, refer to the canonical release plan instructions for this repository to create a release plan using the spec pull request. API spec pull request is required to create a release plan. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#15062 See eng/common workflow