Sync eng/common directory with azure-sdk-tools for PR 15210#46413
Open
Sync eng/common directory with azure-sdk-tools for PR 15210#46413
Conversation
Re-creates PR #15062 on a fresh branch off current upstream/main to avoid sync-pipeline CI issues on the original branch. Original branch squad/15049-sync-shared-skills and PR #15062 are preserved unchanged for comparison. Makes skills the single source of truth by consolidating instruction file content into the corresponding skill SKILL.md files, then deleting the redundant instruction files. Also renames 5 shared skill directories with the 'azsdk-common-' prefix required by the sync pipeline. 7 instruction files deleted (content merged into 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 3 skills enriched with details from instruction files: - generate-sdk-locally: commit checkpoints, language selection, config file identification, SDK project path, metadata update tools, validation params - prepare-release-plan: critical LLM instructions (NextSteps field), Release Planner Tool link, per-language package name extraction rules, valid/invalid examples table, JSON structure, namespace approval flow - sdk-release: readiness check details, interaction flow, do-not-ask-for-PR guard, case-sensitive language note 5 shared skill directories renamed with 'azsdk-common-' prefix: apiview-feedback-resolution, generate-sdk-locally, pipeline-troubleshooting, prepare-release-plan, sdk-release 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 15210, primarily by removing several legacy instruction files and updating the TypeSpec-to-SDK workflow to reference skill-based guidance.
Changes:
- Removed multiple legacy
eng/common/instructions/**markdown instruction files (release, readiness, validation, release-plan workflows). - Updated the TypeSpec-to-SDK instructions to reference
.github/skills/...skill documents for local generation, release-plan prep, and troubleshooting. - Minor formatting tweak in the TypeSpec-to-SDK instruction header.
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 SDK release instruction content (now leaves existing repo links pointing to a missing file). |
| eng/common/instructions/azsdk-tools/verify-namespace-approval.instructions.md | Removed namespace approval instruction content. |
| eng/common/instructions/azsdk-tools/typespec-to-sdk.instructions.md | Updated workflow references to .github/skills/... documents and added skill mentions for troubleshooting/review feedback. |
| eng/common/instructions/azsdk-tools/sdk-details-in-release-plan.instructions.md | Removed release-plan SDK detail update instructions. |
| eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md | Removed local SDK generation workflow (still referenced by Copilot instructions elsewhere in repo). |
| eng/common/instructions/azsdk-tools/create-release-plan.instructions.md | Removed release plan creation instructions. |
| eng/common/instructions/azsdk-tools/check-package-validation.instructions.md | Removed package validation check instructions. |
| eng/common/instructions/azsdk-tools/check-package-readiness.instructions.md | Removed package readiness check instructions. |
Comments suppressed due to low confidence (2)
eng/common/instructions/copilot/sdk-release.instructions.md:1
- This file is being removed, but
.github/copilot-instructions.md(and a mirrored copy undercustom-instructions/repo/.github/) still links toeng/common/instructions/copilot/sdk-release.instructions.md. Either keep this instruction file (or replace it with an equivalent new location) and update those links so the Copilot instructions don’t point at a 404/missing file.
eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md:1 - This instruction file is being removed, but
.github/copilot-instructions.md(and the mirrored copy undercustom-instructions/repo/.github/) still includes#file:../eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md. Either keep this file (or move it and update the#file:include) so Copilot’s TypeSpec workflow reference doesn’t break.
| **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.
#file:.github/skills/azsdk-common-generate-sdk-locally/SKILL.md does not exist in this repo (and there is no azsdk-common-generate-sdk-locally skill directory under .github/skills). This reference will break the instruction flow; either add the missing skill content as part of the sync, or update the #file: pointer to an existing workflow doc in this repo.
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.
This step instructs using the azsdk-common-pipeline-troubleshooting and azsdk-common-apiview-feedback-resolution skills, but neither skill appears to exist anywhere under .github/skills in this repo. Please either include these skills in the sync or adjust the guidance to point to skills/docs that actually exist here.
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, suggest checking pipeline logs for more information, and help diagnose the failure based on the pipeline output and logs. | |
| 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, help analyze the review comments and guide the user through resolving them. |
| 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.
#file:.github/skills/azsdk-common-prepare-release-plan/SKILL.md is referenced here, but there is no corresponding skill directory/file under .github/skills in this repo. This will leave the release-plan step without runnable instructions; either add the skill to the repo as part of the sync or update the reference to an existing release plan workflow document.
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 #file:../copilot/sdk-release.instructions.md 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#15210 See eng/common workflow