Port autorest java customization doc to SDK repository - #50015
Open
XiaofeiCao wants to merge 4 commits into
Open
Port autorest java customization doc to SDK repository#50015XiaofeiCao wants to merge 4 commits into
XiaofeiCao wants to merge 4 commits into
Conversation
Co-authored-by: XiaofeiCao <92354331+XiaofeiCao@users.noreply.github.com>
Co-authored-by: XiaofeiCao <92354331+XiaofeiCao@users.noreply.github.com>
|
Azure Pipelines: Successfully started running 1 pipeline(s). 34 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
weidongxu-microsoft
approved these changes
Aug 4, 2026
weidongxu-microsoft
left a comment
Member
There was a problem hiding this comment.
Two documentation accuracy issues to address.
|
Azure Pipelines: Successfully started running 1 pipeline(s). 34 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
weidongxu-microsoft
approved these changes
Aug 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ports Java customization guidance (previously from the archived autorest.java repo) into azure-sdk-for-java contributor documentation, and wires it into the existing TypeSpec contributor workflow docs so developers can find it when generating/regenerating SDKs.
Changes:
- Added a new contributor guide documenting AST-based Java customization via
azure-autorest-customization. - Linked the new guide from the TypeSpec quickstart and the contributor docs index.
- Updated the SDK generation troubleshooting guide to reference the new customization documentation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/contributor/typespec-quickstart.md | Adds a pointer to the new Java customization guide from the TypeSpec workflow. |
| docs/contributor/typespec-java-customization.md | New guide describing AST-based Java customizations using azure-autorest-customization. |
| docs/contributor/sdk-generation-pipeline-troubleshooting.md | Replaces the old autorest.java link with a link to the new in-repo guide. |
| docs/contributor/README.md | Adds the new guide to the contributor documentation index. |
Suppressed comments (2)
docs/contributor/sdk-generation-pipeline-troubleshooting.md:138
- The
customization-classYAML example currently uses a Java package string, but the TypeSpec docs in this repo showcustomization-classas a path to the customization.javafile. Using the wrong form here can cause generator failures for people following this troubleshooting guide.
This issue also appears on line 134 of the same file.
> Reference: [TypeSpec Java Customization](https://github.com/Azure/azure-sdk-for-java/blob/main/docs/contributor/typespec-java-customization.md)
**Prerequisites for customization:** When adding customization code, two options must be set in `tspconfig.yaml`:
```yaml
options:
docs/contributor/sdk-generation-pipeline-troubleshooting.md:138
- This bullet describes
customization-classas a Java package, which conflicts with the file-path form used elsewhere in the TypeSpec Java customization docs and can mislead readers configuringtspconfig.yaml.
> Reference: [TypeSpec Java Customization](https://github.com/Azure/azure-sdk-for-java/blob/main/docs/contributor/typespec-java-customization.md)
**Prerequisites for customization:** When adding customization code, two options must be set in `tspconfig.yaml`:
```yaml
options:
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Port customization code from archived autorest.java repository.
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 swagger spec, a link to the pull request containing these swagger spec changes has been included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines