GA release of azure-template - #48892
Conversation
|
Azure Pipelines: Successfully started running 1 pipeline(s). 10 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
There was a problem hiding this comment.
🟡 Changes recommended
GA metadata remains marked Beta, and required API snapshot artifacts are removed.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Promotes azure-template to GA version 1.0.0 and updates its release notes.
Changes:
- Updates package version and changelog.
- Removes APIView snapshot artifacts.
File summaries
| File | Description |
|---|---|
CHANGELOG.md |
Adds the 1.0.0 GA entry. |
_version.py |
Sets version to 1.0.0. |
api.md |
Deletes the API snapshot. |
api.metadata.yml |
Deletes snapshot metadata. |
Review details
Suppressed comments (2)
sdk/template/azure-template/api.md:1
- Do not remove the checked-in public API snapshot for this
apistub = truepackage. The API-review release-gating work in #48628 added this exact snapshot, and the other API-stub-enabled package also retainsapi.md; regenerate or restoreapi.md(together with its metadata) so the released surface remains tracked.
sdk/template/azure-template/api.metadata.yml:1 - Keep the companion metadata for the checked-in API snapshot. APIView generation produces
api.metadata.ymlalongsideapi.md, and removing it leaves this API-stub-enabled package inconsistent with the repository's generated API artifacts; regenerate both files rather than deleting them.
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
🔵 Needs a closer look
The deleted API snapshot files are required by the repository’s API consistency check.
Review details
Suppressed comments (2)
sdk/template/azure-template/api.metadata.yml:1
- Deleting this metadata leaves the package without one of the two artifacts required by the API consistency check (
doc/dev/tests.md:150). Regenerate and commitapi.mdandapi.metadata.ymlwithazpysdk apistub .so the metadata also records the new 1.0.0 package version.
sdk/template/azure-template/api.md:1 - Removing the committed API snapshot also removes an artifact required by the repository's API consistency check (
doc/dev/tests.md:150). Keep the snapshot and regenerate it together withapi.metadata.ymlfor the 1.0.0 release.
- Files reviewed: 5/5 changed files
- Comments generated: 0 new
- Review effort level: Balanced
There was a problem hiding this comment.
🟡 Changes recommended
The API artifacts must be regenerated, and the module rename requires release-note documentation.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
Suppressed comments (1)
sdk/template/azure-template/api.md:1
- Deleting the API snapshot leaves this
apistub = truepackage without the generated review artifacts. The apistub workflow generates bothapi.mdandapi.metadata.yml(eng/tools/azure-sdk-tools/azpysdk/apistub.py:240-266), and its tests require both outputs (eng/tools/azure-sdk-tools/tests/test_apistub.py:339-340). Regenerate and commit both files for version 1.0.0 so the snapshot also records the module rename.
- Files reviewed: 6/7 changed files
- Comments generated: 1
- Review effort level: Balanced
Update changelog for release.