[AutoPR arm-automation] SDK Generation from specification/automation/resource-manager/readme.md - API Version 2024-10-23#37791
[AutoPR arm-automation] SDK Generation from specification/automation/resource-manager/readme.md - API Version 2024-10-23#37791azure-sdk wants to merge 3 commits into
Conversation
…, API Version: 2024-10-23, SDK Release Type: stable, and CommitSHA: '7db3daddb5751882a9c7415889d73bcbf45021a1' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6053316 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
github-actions
Bot
added
the
Mgmt
|
@copilot Could you help fix pipeline failure? |
Co-authored-by: MaryGao <9943211+MaryGao@users.noreply.github.com> Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-js/sessions/eb36229f-f60e-4145-8877-8fe8a055bb42
…0.0-beta.6 Co-authored-by: MaryGao <9943211+MaryGao@users.noreply.github.com> Agent-Logs-Url: https://github.com/Azure/azure-sdk-for-js/sessions/eb36229f-f60e-4145-8877-8fe8a055bb42
The pipeline failure was caused by a version mismatch - the auto-generation tool incorrectly set the package version to Fixed in commit bba553b by:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR updates @azure/arm-automation to API version 2024-10-23 (version 11.0.0-beta.6). Version alignment across package.json, automationClient.ts, and CHANGELOG.md is correct. No naming violations, alpha version references, or export gaps were found.
2 design concerns found (breaking changes not documented):
dscCompilationJobOperationsanddscCompilationJobStreamremoved — Two entire operation groups and allDscCompilationJob*types were dropped from the public API. The### Breaking Changessection inCHANGELOG.mdexists but is empty.TrackedResource.locationchanged from optional to required — This is a wide-impact breaking change affecting all resource types (AutomationAccount,Runbook, etc.). It is not documented inCHANGELOG.md.
Both breaking changes need entries in the ### Breaking Changes section of CHANGELOG.md before the release. If any of these were removed/changed in the spec unintentionally, please raise an issue in azure-rest-api-specs.
📊 Structured Report
{"agent":"mgmt-reviewer","pr":37791,"summary":"issues_found","findings":[{"file":"sdk/automation/arm-automation/review/arm-automation-node.api.md","line":302,"issueType":"design","category":"breaking_change","description":"dscCompilationJobOperations and dscCompilationJobStream removed from AutomationClient; all DscCompilationJob* types removed. Breaking Changes section in CHANGELOG.md is empty."},{"file":"sdk/automation/arm-automation/review/arm-automation-node.api.md","line":3640,"issueType":"design","category":"breaking_change","description":"TrackedResource.location changed from optional (location?: string) to required (location: string), affecting all derived resource types. Not documented in CHANGELOG.md."}]}⚡ Benchmarked by Management SDK PR Review
| // (undocumented) | ||
| dscCompilationJobStream: DscCompilationJobStream; | ||
| // (undocumented) | ||
| dscConfigurationOperations: DscConfigurationOperations; |
There was a problem hiding this comment.
🔴 Design Concern — Breaking Changes: dscCompilationJobOperations and dscCompilationJobStream removed from AutomationClient
The two operation groups dscCompilationJobOperations and dscCompilationJobStream (along with all DscCompilationJob* interfaces and types) were removed from the public API surface in this release. This is a breaking change for any customer who currently uses these operations.
These removals indicate that the DscCompilationJob operations were removed from the 2024-10-23 API version spec. The breaking change is acceptable in a beta package, but it must be documented.
Fix: Add entries to the ### Breaking Changes section of CHANGELOG.md describing what was removed. For example:
### Breaking Changes
- `AutomationClient.dscCompilationJobOperations` has been removed; the DSC Compilation Job operations are no longer available in API version 2024-10-23.
- `AutomationClient.dscCompilationJobStream` has been removed.
- All `DscCompilationJob*` types and interfaces have been removed from the public API.
If these operations were removed from the spec unintentionally, raise a spec issue in azure-rest-api-specs and report the generation tooling issue at autorest.typescript.
| // @public | ||
| export interface TrackedResource extends Resource { | ||
| location?: string; | ||
| location: string; |
There was a problem hiding this comment.
🔴 Design Concern — TrackedResource.location changed from optional to required
TrackedResource.location was previously location?: string (optional) and is now location: string (required). Because TrackedResource is a base type for many resource models in this package (e.g., AutomationAccount, Runbook, Module, DscConfiguration, etc.), this is a wide-impact breaking change for any customer code that creates or type-checks these objects without explicitly supplying a location.
Fix: Document this breaking change in the ### Breaking Changes section of CHANGELOG.md:
- `TrackedResource.location` is now required (previously optional). All resource creation parameters must now include a `location` field.
If this change was made unintentionally in the spec, raise an issue in azure-rest-api-specs.
|
Hi @azure-sdk. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days. |
github-actions
Bot
added
the
no-recent-activity
|
Hi @azure-sdk. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing |
Configurations: 'specification/automation/resource-manager/readme.md', API Version: 2024-10-23, SDK Release Type: stable, and CommitSHA: '7db3daddb5751882a9c7415889d73bcbf45021a1' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs'
Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6053316
Packages impacted by this PR
@azure/arm-automationIssues associated with this PR
N/A
Describe the problem that is addressed by this PR
Auto-generated SDK update for
@azure/arm-automationtargeting API version2024-10-23. The auto-generation tool incorrectly reset the package version to1.0.0-beta.1inpackage.jsonandsrc/automationClient.ts, while the correct next version is11.0.0-beta.6(the previously released version was11.0.0-beta.5). This version mismatch caused the CI pipeline to fail.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?
The only fix is to correct the version in
package.jsonand thepackageDetailsconstant insrc/automationClient.tsto match the version already reflected in theCHANGELOG.md(11.0.0-beta.6).Are there test cases added in this PR? (If not, why?)
No new test cases. This is an auto-generated SDK update with a version correction. The build and API extraction were validated successfully.
Provide a list of related PRs (if any)
N/A
Command used to generate this PR: (Applicable only to SDK release request PRs)
Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release.
Checklists
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.