Skip to content

[search] Expand azure-search-documents skill with full release workflow#46567

Merged
hizixin merged 1 commit into
mainfrom
ziyao/search-skill
Apr 29, 2026
Merged

[search] Expand azure-search-documents skill with full release workflow#46567
hizixin merged 1 commit into
mainfrom
ziyao/search-skill

Conversation

@hizixin

@hizixin hizixin commented Apr 28, 2026

Copy link
Copy Markdown
Member

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:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

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>
Copilot AI review requested due to automatic review settings April 28, 2026 01:56
@hizixin hizixin requested review from a team as code owners April 28, 2026 01:56
@hizixin hizixin requested a review from xiangyan99 April 28, 2026 01:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.md into 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.ps1 helper to run commands inside the package .venv without 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.

@hizixin hizixin requested a review from a team April 29, 2026 17:42
@hizixin

hizixin commented Apr 29, 2026

Copy link
Copy Markdown
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.

@github-project-automation github-project-automation Bot moved this from Untriaged to In Progress in Azure SDK for Search Apr 29, 2026
@hizixin hizixin merged commit 86f695a into main Apr 29, 2026
28 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Azure SDK for Search Apr 29, 2026
@hizixin hizixin deleted the ziyao/search-skill branch April 29, 2026 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants