Deprecation Process

April 23, 2026 · View on GitHub

Short link: aka.ms/azsdk/java/deprecation-process

This document describes how to mark a package deprecated on Maven.

Overview

Maven has no official deprecation mechanism. The recommended approach is:

  1. Add a deprecation notice to README.md, the POM description, and CHANGELOG.md.
  2. Push a final release to Maven.

Step 1 – Update Files in the Repository

README.md — Add a deprecation disclaimer

> Please note, this package has been deprecated and will no longer be maintained
> after `<EOLDate>`. We encourage you to upgrade to the replacement package,
> `<Replacement>`, to continue receiving updates. Refer to the migration guide
> `<MigrationGuideURL>` for guidance on upgrading. Refer to our
> [deprecation policy](https://aka.ms/azsdk/support-policies) for more details.

CHANGELOG.md — Add a version entry with the same disclaimer

## 1.0.1 (2024-01-15)

> Please note, this package has been deprecated ...

pom.xml — Add the disclaimer to <description>

<description>Please note, this package has been deprecated ...</description>

eng/versioning/version_client.txt — Align current-version with the release

If current-version is ahead of the intended release version, set it to the release version:

- com.azure:azure-example;1.0.0;1.1.0-beta.1
+ com.azure:azure-example;1.0.0;1.0.1

Submit a PR to main and post it in the Java language channel.

Step 2 – Trigger a Release

Trigger the library's standard release pipeline as documented in:

https://aka.ms/azsdk/release-checklist

See Also