Skip to content

Port autorest java customization doc to SDK repository - #50015

Open
XiaofeiCao wants to merge 4 commits into
mainfrom
copilot/port-autorest-java-customization-doc
Open

Port autorest java customization doc to SDK repository#50015
XiaofeiCao wants to merge 4 commits into
mainfrom
copilot/port-autorest-java-customization-doc

Conversation

@XiaofeiCao

Copy link
Copy Markdown
Contributor

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:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Copilot AI and others added 2 commits August 3, 2026 09:16
Co-authored-by: XiaofeiCao <92354331+XiaofeiCao@users.noreply.github.com>
Co-authored-by: XiaofeiCao <92354331+XiaofeiCao@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
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 weidongxu-microsoft left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two documentation accuracy issues to address.

Comment thread docs/contributor/typespec-java-customization.md Outdated
Comment thread docs/contributor/typespec-java-customization.md Outdated
@XiaofeiCao
XiaofeiCao marked this pull request as ready for review August 4, 2026 03:44
@XiaofeiCao
XiaofeiCao requested a review from a team as a code owner August 4, 2026 03:44
Copilot AI lite review requested due to automatic review settings August 4, 2026 03:44
@azure-pipelines

Copy link
Copy Markdown
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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-class YAML example currently uses a Java package string, but the TypeSpec docs in this repo show customization-class as a path to the customization .java file. 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-class as a Java package, which conflicts with the file-path form used elsewhere in the TypeSpec Java customization docs and can mislead readers configuring tspconfig.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:

Comment thread docs/contributor/typespec-java-customization.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants