Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transition to New Codesnippet Tooling #24958

Closed
30 of 32 tasks
alzimmermsft opened this issue Oct 21, 2021 · 3 comments
Closed
30 of 32 tasks

Transition to New Codesnippet Tooling #24958

alzimmermsft opened this issue Oct 21, 2021 · 3 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.

Comments

@alzimmermsft
Copy link
Member

alzimmermsft commented Oct 21, 2021

Recently, new codesnippet tooling was introduced for the Azure SDKs. The new tooling works for all LTS Java versions, whereas the previous tooling only worked with Java 8 and 11, and supports handling README codesnippets, which there is another tool handling this. This issue is meant to track transitioning all SDKs to using the new codesnippet tooling for both Javadocs and README codesnippets, and once this issue is closed references to the old tooling will be removed.

The following SDKs need to be update:

For reference, this PR transitioned azure-search-documents to the new tooling and this PR transitioned azure-data-appconfiguration.

Additionally, as resolving this issue each SDK must pass Javadoc generation using Java 17, the latest LTS version. The reason for this is there is additional Javadoc linting that Java 17 does and this will help unblock including/using Java 17 in our CI pipelines.

PR Checklist

This is a checklist to verify you can check off an SDK listed above.

  • No usage of @codesnippet in Javadocs
  • No usage of embedme for README codesnippets
  • Build passes when using Java 17
@alzimmermsft alzimmermsft added EngSys This issue is impacting the engineering system. Client This issue points to a problem in the data-plane of the library. labels Oct 21, 2021
@alzimmermsft alzimmermsft self-assigned this Oct 21, 2021
This was referenced Oct 21, 2021
@samvaity
Copy link
Member

@alzimmermsft Do we want to add a separate tracking issue for resource manager SDK's?

@alzimmermsft
Copy link
Member Author

@alzimmermsft Do we want to add a separate tracking issue for resource manager SDK's?

Management SDKs don't use codesnippet tooling at this time.

@alzimmermsft
Copy link
Member Author

Closing as transitioning to the new codesnippet tooling has been completed

@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Projects
None yet
Development

No branches or pull requests

2 participants