Add typespec sync GH action workflow to automate emitted code merge by glharper · Pull Request #37806 · Azure/azure-sdk-for-js

glharper · 2026-03-24T15:46:56Z

Packages impacted by this PR

Issues associated with this PR

Describe the problem that is addressed by this PR

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Are there test cases added in this PR? (If not, why?)

Provide a list of related PRs (if any)

Command used to generate this PR:***(Applicable only to SDK release request PRs)*

Checklists

Added impacted package name to the issue description
Does this PR needs any fixes in the SDK Generator?** (If so, create an Issue in the Autorest/typescript repository and link it here)
Added a changelog (if necessary)

…ions and related types - Add getCredentials and pendingUpload operations to beta evaluators - Add EvaluatorCredentialRequest model type - Add entry_point and image_tag optional fields to CodeBasedEvaluatorDefinition - Add merge_prompt.md script for future three-way TypeSpec merges - Update CHANGELOG.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

### Packages impacted by this PR ### Issues associated with this PR ### Describe the problem that is addressed by this PR ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)

…c-workflow

### Packages impacted by this PR ### Issues associated with this PR ### Describe the problem that is addressed by this PR ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)

Added comments to clarify workflow requirements and behavior.

Copilot

Pull request overview

This PR introduces automation intended to keep a TypeSpec-based SDK in sync with its upstream spec, while also updating @azure/ai-projects to include newly generated/updated API surface (notably beta evaluators and toolsets) and the associated public exports/changelog.

Changes:

Added a scheduled + manual GitHub Actions workflow to detect spec repo updates, regenerate the client, and push the result to a target branch.
Updated @azure/ai-projects public surface to include new models/operation groups (e.g., beta evaluators credentials/pending upload, beta toolsets) and refreshed generated artifacts.
Bumped @azure/ai-projects version and updated the changelog; enabled a previously commented-out streaming test.

Reviewed changes

Copilot reviewed 19 out of 85 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`.github/workflows/typespec-sync.yml`	Adds automation to detect spec changes and regenerate/push updated emitted code.
`sdk/ai/ai-projects/package.json`	Version bump; adds `generate:client` script and a new devDependency.
`sdk/ai/ai-projects/CHANGELOG.md`	Documents new features for the new version.
`sdk/ai/ai-projects/src/index.ts`	Exposes newly added types and beta operation option types from the public entrypoint.
`sdk/ai/ai-projects/src/models/index.ts`	Re-exports new model types related to toolsets/evaluators.
`sdk/ai/ai-projects/src/classic/**`	Adds beta `toolsets` operation group wiring and new beta evaluator operations.
`sdk/ai/ai-projects/src/api/beta/**`	Adds new beta toolsets operations + options; extends evaluators operations/options.
`sdk/ai/ai-projects/generated/**`	Adds/updates generated client, helpers, and operation-group implementations.
`sdk/ai/ai-projects/review/ai-projects-node.api.md`	Updates API review surface to reflect new exports/types/operations.
`sdk/ai/ai-projects/test/public/agents/bingCustomSearch.spec.ts`	Re-enables the streaming test case by removing the commented-out `it(` wrapper.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…zure/azure-sdk-for-js into glharper/ai-proj-sync-workflow

Co-authored-by: Deyaa <dealmaha@microsoft.com>

weshaggard · 2026-03-25T16:33:21Z

+          API_URL+="&per_page=1"
+
+          echo "Querying: $API_URL"
+          RESPONSE=$(curl -sf "$API_URL")


GH aggressively rate limits anonymous calls to their APIs so this may fail.

That's unfortunate for one curl every 24h. What would you suggest?

deyaaeldeen · 2026-03-25T16:34:31Z

+          fetch-depth: 0
+          persist-credentials: true
+
+          node-version: "20.x"


is this correct?

GH Copilot code review told me to make it node v20.

weshaggard · 2026-03-25T16:35:16Z

@@ -0,0 +1,182 @@
+# Workflow: TypeSpec Sync


@deyaaeldeen this looks to be scoped to just the ai projects do are there plans to do this for other sdks?

@glharper I'm also curious why we are choosing to use this approach over the usual pipeline we use to create PRs when specs change? cc @raych1

@deyaaeldeen this looks to be scoped to just the ai projects do are there plans to do this for other sdks?

Not that I am aware of. I am also curious about whether the auto PR pipeline could help here but I am not familiar with it. /cc @MaryGao

@deyaaeldeen this is the JS pipeline. It's used in both the spec PR and release scenarios.

@weshaggard This adds the "generate:client" step, where the emitted code is merged with existing custom code. The issue with the "push from TypeSpec repo" approach is that each language has its own approach to dealing with custom code in TypeSpec-based libs, as well as post-emitter steps (dealing with idiosyncratic lang-specific emitter behavior).

generate:client step runs 'tsp-client update' which is essentially same as the command - 'tsp-client init --update-if-exists' ran in the pipeline.

Yes, we would use tsp-client update for generation and we would also run a series of necessary commands e.g code build, format, sample publish, code snippet update, customization apply etc. Let us know if there are some commands need to tweak.

glharper and others added 18 commits March 17, 2026 12:34

correct emitted api-version string

3a8d023

remove merge prompt file which is not needed

7d8b0d1

remove foundryFeatures from new APIs

d9c4289

update Changelog

3d64992

correct comment

f43b273

set real date for 2.0.2 to pass CI

3a99ffb

another changelog change

e4c220e

test package update

06ecdaa

try package fix again

ebe0af3

package version bump

e65b37e

Changelog update

605fd4a

add generate:client script to package.json

c96387e

[Projects] add sync workflow

d09499f

Add pull_request trigger to typespec-sync workflow

2279075

Merge branch 'feature/ai-projects-v2.0.2b1' into glharper/ai-proj-syn…

91ac9f3

…c-workflow

glharper requested a review from deyaaeldeen March 24, 2026 15:46

glharper requested review from a team, bobogogo1990, dargilco and ganeshyb as code owners March 24, 2026 15:46

Copilot AI review requested due to automatic review settings March 24, 2026 15:46

Copilot started reviewing on behalf of glharper March 24, 2026 15:48 View session

Enhance comments in typespec-sync.yml

bdd3411

Added comments to clarify workflow requirements and behavior.

Copilot AI reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

glharper marked this pull request as draft March 24, 2026 15:55

glharper and others added 2 commits March 24, 2026 12:18

revert src changes to main

a6bff21

Apply suggestion from @Copilot

adeffe1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

glharper added 2 commits March 24, 2026 12:24

revert 2.0.2 changes for this PR

f3b2df4

Merge branch 'glharper/ai-proj-sync-workflow' of https://github.com/A…

a0202d5

…zure/azure-sdk-for-js into glharper/ai-proj-sync-workflow

glharper marked this pull request as ready for review March 24, 2026 16:25

fix build error

78d7037

glharper requested review from a team and jeremymeng as code owners March 24, 2026 17:41

glharper added 5 commits March 24, 2026 14:35

Merge branch 'main' into glharper/ai-proj-sync-workflow

c1bb566

revert lock file

69379cd

add new lib to lockfile

1e6861a

update version

cdbf6f6

reserve future feature for different PR

279cd59

deyaaeldeen reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

deyaaeldeen reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

deyaaeldeen reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

deyaaeldeen reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

deyaaeldeen reviewed Mar 24, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml

glharper and others added 3 commits March 25, 2026 10:55

Update .github/workflows/typespec-sync.yml

734c255

Co-authored-by: Deyaa <dealmaha@microsoft.com>

Update .github/workflows/typespec-sync.yml

ea0bd01

Co-authored-by: Deyaa <dealmaha@microsoft.com>

review feedback

aac05e9

weshaggard reviewed Mar 25, 2026

View reviewed changes

Comment thread .github/workflows/typespec-sync.yml Outdated

weshaggard reviewed Mar 25, 2026

View reviewed changes

deyaaeldeen reviewed Mar 25, 2026

View reviewed changes

weshaggard reviewed Mar 25, 2026

View reviewed changes

add real email for git config

db74061

glharper closed this Mar 27, 2026

Conversation

glharper commented Mar 24, 2026

Packages impacted by this PR

Issues associated with this PR

Describe the problem that is addressed by this PR

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Are there test cases added in this PR? (If not, why?)

Provide a list of related PRs (if any)

Command used to generate this PR:**(Applicable only to SDK release request PRs)

Checklists

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Command used to generate this PR:***(Applicable only to SDK release request PRs)*