Skip to content

[Key Vault JCA] Included the org.brotli:dec library in the list of shaded dependencies to avoid issues when generating and publishing docs to MSLearn #45395

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vcolin7
Copy link
Member

@vcolin7 vcolin7 commented May 19, 2025

Recently, we had an issue during the last release of the Key Vault JCA library where the step that publishes docs to MSLearn failed due to an internal tool expecting the library to include optional libraries some shaded code depends on. While not a fix, this should help as a workaround until said tool gets patched.

…ies to avoid issues when generating and publishing docs to MSLearn.
@Copilot Copilot AI review requested due to automatic review settings May 19, 2025 19:47
@github-actions github-actions bot added the azure-spring All azure-spring related issues label May 19, 2025
@vcolin7 vcolin7 self-assigned this May 19, 2025
@vcolin7 vcolin7 added KeyVault Client This issue points to a problem in the data-plane of the library. Docs azure-spring-jca and removed azure-spring All azure-spring related issues labels May 19, 2025
@vcolin7 vcolin7 requested review from scbedd and removed request for Copilot May 19, 2025 19:48
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds the org.brotli:dec library to the shaded dependencies to satisfy an internal docs-publishing tool.

  • Added org.brotli:dec as an optional dependency in the POM.
  • Configured shading relocations and include rules for brotli in the Maven shade plugin.
  • Updated external dependencies list and documented the change in the changelog.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
sdk/keyvault/azure-security-keyvault-jca/pom.xml Added optional brotli dependency, shading relocation, and include
sdk/keyvault/azure-security-keyvault-jca/CHANGELOG.md Documented inclusion of org.brotli:dec
eng/versioning/external_dependencies.txt Registered org.brotli:dec;0.1.2 in external dependencies
Comments suppressed due to low confidence (2)

sdk/keyvault/azure-security-keyvault-jca/pom.xml:282

  • [nitpick] Consider adding or updating an integration test to verify that the brotli classes are correctly shaded and available at runtime for docs generation.
<include>org.brotli:dec:[0.1.2]</include>

sdk/keyvault/azure-security-keyvault-jca/pom.xml:46

  • [nitpick] Align the indentation of the new <dependency> block with the surrounding entries to maintain POM readability and consistency.
<dependency>

@vcolin7 vcolin7 changed the title Included the org.brotli:dec library in the list of shaded dependencies to avoid issues when generating and publishing docs to MSLearn [Key Vault JCA] Included the org.brotli:dec library in the list of shaded dependencies to avoid issues when generating and publishing docs to MSLearn May 19, 2025
Copy link
Contributor

API Change Check

APIView identified API level changes in this PR and created the following API reviews

com.azure:azure-security-keyvault-jca

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
azure-spring-jca Client This issue points to a problem in the data-plane of the library. Docs KeyVault
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant