[search] Expand azure-search-documents skill with full release workflow#46567
Merged
Conversation
The existing skill on main covered only the post-regeneration _patch.py audit (SKILL.md + customizations.md). This commit expands it into the full release workflow (Phase 0-7: scope, generate, sync, test, lint, changelog, samples, version) and reorganizes the customization material so each file has a single concern. - SKILL.md: rewritten as the workflow backbone; _patch.py reconciliation is now Phase 2 of a larger pipeline. - references/architecture.md (new): source layout, branching strategy, CHANGELOG conventions. - references/testing.md (new): unit and live test workflow. - references/customizations.md: Generated-vs-Handwritten rules, _patch.py map, Patterns Reference, per-file inventory (lifted out of SKILL.md tail and architecture material). - scripts/run-in-venv.ps1 (new): portable per-call wrapper that resolves the package .venv from any CWD. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Expands the azure-search-documents GitHub skill from a post-regeneration _patch.py audit into a full end-to-end release workflow, and splits supporting guidance into focused reference documents plus a helper script for running commands inside the package venv.
Changes:
- Rewrites
SKILL.mdinto a phased (0–7) release workflow covering generation, reconciliation, testing, lint/checks, changelog, samples, and versioning. - Adds reference docs for architecture/release conventions and testing workflow; reorganizes customization documentation into a comprehensive catalog.
- Adds
run-in-venv.ps1helper to run commands inside the package.venvwithout manual activation.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
sdk/search/azure-search-documents/.github/skills/azure-search-documents/SKILL.md |
New workflow-oriented skill entrypoint; adds venv wrapper guidance and phased release steps. |
sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/architecture.md |
New release/branching/source-layout and CHANGELOG conventions reference. |
sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/testing.md |
New unit/live testing + recording workflow reference. |
sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/customizations.md |
Reorganized customization catalog with _patch.py map, patterns, and per-file inventory. |
sdk/search/azure-search-documents/.github/skills/azure-search-documents/scripts/run-in-venv.ps1 |
New PowerShell wrapper to execute commands within the package .venv. |
xiangyan99
reviewed
Apr 29, 2026
xiangyan99
reviewed
Apr 29, 2026
Member
Author
|
I'll merge this skill for now so we can start using it. There will be a shared create-package-skill #46523 that all packages can use, which should resolve most of the comments raised here. |
efrainretana
approved these changes
Apr 29, 2026
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.
The existing skill on main covered only the post-regeneration _patch.py audit (SKILL.md + customizations.md). This commit expands it into the full release workflow (Phase 0-7: scope, generate, sync, test, lint, changelog, samples, version) and reorganizes the customization material so each file has a single concern.
SKILL.md: rewritten as the workflow backbone; _patch.py reconciliation is now Phase 2 of a larger pipeline.
references/architecture.md (new): source layout, branching strategy, CHANGELOG conventions.
references/testing.md (new): unit and live test workflow.
references/customizations.md: Generated-vs-Handwritten rules, _patch.py map, Patterns Reference, per-file inventory (lifted out of SKILL.md tail and architecture material).
scripts/run-in-venv.ps1 (new): portable per-call wrapper that resolves the package .venv from any CWD.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines