Open the regeneration PR for ai-projects
When to Use
- The previous five skills (
regenerate-from-typespec, apply-post-emitter-edits, author-samples, author-tests, update-changelog) have all completed.
- The working tree has staged-able changes only in
sdk/ai/ai-projects/.
- You're ready to publish a draft PR for human review.
Inputs
| Name |
Default |
Description |
tspCommit |
required |
The 40-char SHA from tsp-location.saved.yaml (the upstream commit being pulled in). |
branchName |
regen/ai-projects/<short-sha>-<yyyyMMdd> |
Branch name to create outside a managed agent session. |
baseBranch |
main |
Branch from which the task starts and which the PR targets. |
remote |
origin |
Git remote to push to outside a managed agent session. |
samplesNoOp |
false |
Assert that author-samples completed as a documented no-op. |
testsNoOp |
false |
Assert that author-tests completed as a documented no-op. |
managedAgentSession |
false |
Keep the current Copilot-owned branch and leave push/PR publication to the session. |
Prerequisites
- For manually dispatched tasks,
gh CLI installed and authenticated against Azure/azure-sdk-for-js.
- Clean working tree apart from changes under
sdk/ai/ai-projects/.
- Empty Git index; the script stages each logical commit group itself.
Procedure
Run from sdk/ai/ai-projects/ (the script cds to the repo root as needed).
Step 1: Create branch and stage commits
./.github/skills/open-regeneration-pr/scripts/open-pr.ps1 -TspCommit <40-char-sha> -BaseBranch main
The script (scripts/open-pr.ps1) does:
- Aborts if the Git index is non-empty or there are unstaged changes outside
sdk/ai/ai-projects/.
- In manual mode, fetches
remote/baseBranch, requires the current HEAD to equal that fetched tip, then creates regen/ai-projects/<short-sha>-<yyyyMMdd>.
- Stages three to five non-empty logical commits, each scoped via path filters:
[ai-projects] regen: emitter output @ <short-sha> — generated/, tsp-location.saved.yaml.[ai-projects] regen: post-emitter edits — src/, API reports, and post-emitter workaround data (excluding samples/tests).[ai-projects] regen: samples for new features — samples-dev/, omitted when sample authoring was a documented no-op.[ai-projects] regen: tests for new GA features — test/, omitted when test authoring was a documented no-op.[ai-projects] regen: changelog — CHANGELOG.md.
- Pushes to
origin (no force).
- Calls
gh pr create --draft against baseBranch with title [ai-projects] Regenerate from azure-rest-api-specs@<short-sha> and a body templated from changelog content + a verification checklist.
Managed Copilot issue session
When this workflow started by assigning an issue to Copilot, the session already owns exactly one branch and one draft pull request. Run:
./.github/skills/open-regeneration-pr/scripts/open-pr.ps1 `
-TspCommit <40-char-sha> `
-BaseBranch <issue-base-branch> `
-ManagedAgentSession
Pass -SamplesNoOp or -TestsNoOp only when the corresponding authoring skill explicitly completed as a documented no-op; omit each switch when that skill produced changes.
Managed mode keeps the current branch and prepares the same logical commits, but does not switch branches, push, or call gh pr create. The Copilot session publishes its existing branch and updates its existing draft PR.
Step 2: Verify
- The PR shows up as Draft in GitHub.
- The PR body links the upstream commit:
https://github.com/Azure/azure-rest-api-specs/commit/<sha>.
- The verification checklist (build, format, test TypeScript/lint, build:samples) reports the checks that actually ran.
Safety rails
- Never runs
git push --force or git push --force-with-lease.
- Never opens a non-draft PR — humans flip it to "ready for review".
- In managed mode, never creates a branch, pushes manually, or opens a second PR.
- Never stages files outside
sdk/ai/ai-projects/.
- Rejects a non-empty Git index before staging any logical commit group.
- In manual mode, requires
HEAD to equal the freshly fetched remote/baseBranch tip.
- Requires emitter output, post-emitter edits, and changelog commit groups to be non-empty. Empty sample and test groups require the corresponding explicit no-op switch, and a group marked as a no-op must not contain changes.
- Aborts before publishing if any package changes remain outside the recognized commit groups.
1---2name: open-regeneration-pr3description: Commit ai-projects regeneration output and finish a draft GitHub PR. Use when the prior five regen skills are complete. Supports either a manually dispatched task that creates and pushes a branch via gh, or an issue-assigned Copilot session that already owns its branch and PR. Stages three to five non-empty logical commits and never force-pushes.4---56# Open the regeneration PR for ai-projects78## When to Use910- The previous five skills (`regenerate-from-typespec`, `apply-post-emitter-edits`, `author-samples`, `author-tests`, `update-changelog`) have all completed.11- The working tree has staged-able changes only in `sdk/ai/ai-projects/`.12- You're ready to publish a **draft** PR for human review.1314## Inputs1516| Name | Default | Description |17| --------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- |18| `tspCommit` | _required_ | The 40-char SHA from `tsp-location.saved.yaml` (the upstream commit being pulled in). |19| `branchName` | `regen/ai-projects/<short-sha>-<yyyyMMdd>` | Branch name to create outside a managed agent session. |20| `baseBranch` | `main` | Branch from which the task starts and which the PR targets. |21| `remote` | `origin` | Git remote to push to outside a managed agent session. |22| `samplesNoOp` | `false` | Assert that `author-samples` completed as a documented no-op. |23| `testsNoOp` | `false` | Assert that `author-tests` completed as a documented no-op. |24| `managedAgentSession` | `false` | Keep the current Copilot-owned branch and leave push/PR publication to the session. |2526## Prerequisites2728- For manually dispatched tasks, `gh` CLI installed and authenticated against `Azure/azure-sdk-for-js`.29- Clean working tree apart from changes under `sdk/ai/ai-projects/`.30- Empty Git index; the script stages each logical commit group itself.3132## Procedure3334Run from `sdk/ai/ai-projects/` (the script `cd`s to the repo root as needed).3536### Step 1: Create branch and stage commits3738```powershell39./.github/skills/open-regeneration-pr/scripts/open-pr.ps1 -TspCommit <40-char-sha> -BaseBranch main40```4142The script ([scripts/open-pr.ps1](./scripts/open-pr.ps1)) does:43441. Aborts if the Git index is non-empty or there are unstaged changes outside `sdk/ai/ai-projects/`.452. In manual mode, fetches `remote/baseBranch`, requires the current `HEAD` to equal that fetched tip, then creates `regen/ai-projects/<short-sha>-<yyyyMMdd>`.463. Stages three to five non-empty logical commits, each scoped via path filters:47 - `[ai-projects] regen: emitter output @ <short-sha>` — `generated/`, `tsp-location.saved.yaml`.48 - `[ai-projects] regen: post-emitter edits` — `src/`, API reports, and post-emitter workaround data (excluding samples/tests).49 - `[ai-projects] regen: samples for new features` — `samples-dev/`, omitted when sample authoring was a documented no-op.50 - `[ai-projects] regen: tests for new GA features` — `test/`, omitted when test authoring was a documented no-op.51 - `[ai-projects] regen: changelog` — `CHANGELOG.md`.524. Pushes to `origin` (no force).535. Calls `gh pr create --draft` against `baseBranch` with title `[ai-projects] Regenerate from azure-rest-api-specs@<short-sha>` and a body templated from changelog content + a verification checklist.5455### Managed Copilot issue session5657When this workflow started by assigning an issue to Copilot, the session already owns exactly one branch and one draft pull request. Run:5859```powershell60./.github/skills/open-regeneration-pr/scripts/open-pr.ps1 `61 -TspCommit <40-char-sha> `62 -BaseBranch <issue-base-branch> `63 -ManagedAgentSession64```6566Pass `-SamplesNoOp` or `-TestsNoOp` only when the corresponding authoring skill explicitly completed as a documented no-op; omit each switch when that skill produced changes.6768Managed mode keeps the current branch and prepares the same logical commits, but does not switch branches, push, or call `gh pr create`. The Copilot session publishes its existing branch and updates its existing draft PR.6970### Step 2: Verify7172- The PR shows up as **Draft** in GitHub.73- The PR body links the upstream commit: `https://github.com/Azure/azure-rest-api-specs/commit/<sha>`.74- The verification checklist (build, format, test TypeScript/lint, build:samples) reports the checks that actually ran.7576## Safety rails7778- **Never** runs `git push --force` or `git push --force-with-lease`.79- **Never** opens a non-draft PR — humans flip it to "ready for review".80- In managed mode, **never** creates a branch, pushes manually, or opens a second PR.81- **Never** stages files outside `sdk/ai/ai-projects/`.82- Rejects a non-empty Git index before staging any logical commit group.83- In manual mode, requires `HEAD` to equal the freshly fetched `remote/baseBranch` tip.84- Requires emitter output, post-emitter edits, and changelog commit groups to be non-empty. Empty sample and test groups require the corresponding explicit no-op switch, and a group marked as a no-op must not contain changes.85- Aborts before publishing if any package changes remain outside the recognized commit groups.
Azure