Skip to content

Add deprecation guide for packages and APIs#6927

Closed
Copilot wants to merge 199 commits intomainfrom
copilot/add-document-on-deprecating-packages
Closed

Add deprecation guide for packages and APIs#6927
Copilot wants to merge 199 commits intomainfrom
copilot/add-document-on-deprecating-packages

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 23, 2026

Description

Adds comprehensive deprecation documentation at /doc/deprecation.md covering package and API lifecycle management.

Changes

  • Created /doc/deprecation.md

    • Links to Azure SDK support/deprecation policies (no content duplication)
    • C++ implementation patterns using [[deprecated]] attributes
    • Doxygen @deprecated documentation conventions
    • Package-level deprecation workflow
    • Migration guide requirements and examples
  • Updated README.md and CONTRIBUTING.md

    • Added navigation links to deprecation guide

Example Usage

/**
 * @brief Performs an old operation.
 * 
 * @deprecated This function is deprecated as of version 2.0.0.
 * Use NewFunction() instead for improved performance.
 */
[[deprecated("Use NewFunction() instead. Removed in version 3.0.0.")]]
int OldFunction(int input);

Pull Request Checklist

  • C++ Guidelines
  • Doxygen docs
  • Unit tests - N/A (documentation only)
  • No unwanted commits/changes
  • Descriptive title/description
    • PR is single purpose
    • Related issue listed
  • Comments in source - N/A (documentation only)
  • No typos
  • Update changelog - N/A (documentation only)
  • Not work-in-progress
  • External references or docs updated
  • Self review of PR done
  • Any breaking changes? - No
Original prompt

This section details on the original issue you should resolve

<issue_title>Add document describing how to deprecate packages</issue_title>
<issue_description>Add instructions on how to deprecate modules into a document at /doc/deprecation.md (or similar).
Link the page in our repo to the Azure SDK "Deprecating Azure SDKs" page.

General SDK patterns for deprecation should be followed.

Do not duplicate information that is already in the https://azure.github.io/azure-sdk/policies_support.html document. Link to the relevant sections.
</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Copilot AI changed the title [WIP] Add document describing how to deprecate packages Add deprecation guide for packages and APIs Jan 23, 2026
Copilot AI requested a review from RickWinter January 23, 2026 22:42
azure-sdk and others added 22 commits January 23, 2026 15:23
Co-authored-by: Scott Beddall <scbedd@microsoft.com>
Bumps the npm_and_yarn group with 1 update in the /eng/common/tsp-client directory: [tar](https://github.com/isaacs/node-tar).

Updates `tar` from 7.4.3 to 7.5.3
- [Release notes](https://github.com/isaacs/node-tar/releases)
- [Changelog](https://github.com/isaacs/node-tar/blob/main/CHANGELOG.md)
- [Commits](isaacs/node-tar@v7.4.3...v7.5.3)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Bump github.com/microsoft/vcpkg from master to 2026.01.16

Bumps [github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg) from master to 2026.01.16. This release includes the previously tagged commit.
- [Release notes](https://github.com/microsoft/vcpkg/releases)
- [Commits](microsoft/vcpkg@84bab45...66c0373)

---
updated-dependencies:
- dependency-name: github.com/microsoft/vcpkg
  dependency-version: 2026.01.16
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update default VCPKG commit string

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Anton Kolesnyk <41349689+antkmsft@users.noreply.github.com>
* Initial plan

* Remove DOTNET_ROLL_FORWARD from CI YAML files

Co-authored-by: danieljurek <2158838+danieljurek@users.noreply.github.com>

* Revert changes to eng/common folder, keep only eng/pipelines changes

Co-authored-by: danieljurek <2158838+danieljurek@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: danieljurek <2158838+danieljurek@users.noreply.github.com>
…6935)

* Few more changes

* review comment resolution- 5

---------

Co-authored-by: anannya03 <aaniee09@gmail.com>
* Initial plan

* Update dependabot config: change exclude-paths pattern

Co-authored-by: danieljurek <2158838+danieljurek@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: danieljurek <2158838+danieljurek@users.noreply.github.com>
Co-authored-by: Scott Beddall (from Dev Box) <scbedd@microsoft.com>
Co-authored-by: anannya03 <aaniee09@gmail.com>
* Add instruction to normalize package name

* Add javascript validation

* Add examples

---------

Co-authored-by: Summer Warren <summerwarren@microsoft.com>
* Mark package as released using azsdk cli command
* Sorting owners

* Sorting labels

* Sorting entries

* Sorting owners

* Sorting labels

* Sorting entries
The eng/common/scripts/login-to-github.ps1 script was failing because it was using the standard Base64 encoded
  signature returned by Azure Key Vault directly in the JWT, instead of converting it to Base64URL format (which
  replaces + with -, / with _, and removes trailing =).

  I have fixed the script by adding the necessary character replacements and also added a 10-second clock skew buffer
  to the iat (issued at) claim to ensure validity.

  The script now runs successfully and logs in as azure-sdk-automation[bot].

  Changes made:

   - Modified eng/common/scripts/login-to-github.ps1:
    - Converted the signature from Azure Key Vault to Base64URL format.
    - Subtracted 10 seconds from the iat claim to account for potential clock skew.

  Verification:

   - Ran the script and confirmed it successfully resolved the installation ID for "Azure" and obtained an access
  token.
   - gh auth status output confirms successful login.

Co-authored-by: Wes Haggard <Wes.Haggard@microsoft.com>
* Storage/STG101/content validation (#6850)

* Storage STG99/Content Validation - Main Function and Blob Support (#6407)

* Content Validation

* Add blob support

* fix init

* update logic

* update logic

* update

* Update

* Update build failure

* Update init

* Fix clang format

* update docs

* Rebase main

* Storage/Content Validation Part2 (#6530)

* Add file and datalake support

* Update test cases

* Update Logic

* Update test case

* Fix failure

* Update test case.

* update test record

* fix cspell.

* Protocol Layer

* Storage/STG101/Cross-tenant principal bound sas (#6863)

* Cross-tenant principal bound sas

* Fix test failure

* Add Dynamic Sas support (#6868)

* Storage/Stg101/Source Customer Provided Key and AccessTierConditions for Delete Blob API (#6869)

* Source CMK and Delete condition for AccessTier

* Rename

* Fix Cspell

* Storage/STG101 Add test cases for features (#6933)

* Add test cases for STG101 feature

* Fix clang format

* Add more cases for content validation (#6943)

* Storage/STG101/Content validation client option support (#6945)

* Content validation client option support

* Update test cases

* Fix test case

* FIx test case

* Fix test case

* Fix test failure

* Remove dup fields

* Fix comment

* Storage/STG101/fix comments (#6949)

* Fix comments

* Add end line

* Fix build failure

* Update test case

* Update

* Add comments

* Update test case.

* Fix API View comments

* Fix comments

* Improve code structures

* Update with comments

* Fix clang format

* Improve code structure.

* Fix comments

* Fix clang format.

* Improve structured message test cases

* Fix clang format

* Fix clang format failure

* Fix cspell

* Change the type to final
* Updated deployment setting to use http

* Use parameters.AdditionalParameters in yaml

---------

Co-authored-by: Chidozie Ononiwu <chononiw@microsoft.com>
Co-authored-by: Travis Prescott <trpresco@microsoft.com>
…6969)

* Use 1ES pool for post-apiview github workflow

* Properly check for PR

---------

Co-authored-by: Wes Haggard <Wes.Haggard@microsoft.com>
For Java packages, the release tag used in link substitution now includes
the groupId in the format 'groupId+Name_Version' (e.g.,
'com.azure+azure-core_1.0.0'). This ensures correct tag matching for
Java packages which require the groupId prefix.

Co-authored-by: Ray Chen <raychen@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
azure-sdk and others added 11 commits April 14, 2026 17:03
* Add rust to prepare-pipelines

* Use existing rust info with narrower variable group specifications

* Space

---------

Co-authored-by: Daniel Jurek <djurek@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: anannya03 <aaniee09@gmail.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* use doc-warden from feed directly. no more pypi

---------

Co-authored-by: Scott Beddall <scbedd@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* override lodash to latest

* npm i

---------

Co-authored-by: Mike Harder <mharder@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* fix the deps installation

* Update eng/common/scripts/Verify-Readme.ps1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Scott Beddall <scbedd@microsoft.com>
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: Ben Broderick Phillips <bebroder@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* Add SDK Validation check name filter to post-apiview workflow

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fixed format issue

---------

Co-authored-by: Ray Chen <raychen@microsoft.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* Bump @azure-tools/typespec-client-generator-cli

Bumps [@azure-tools/typespec-client-generator-cli](https://github.com/Azure/azure-sdk-tools) from 0.31.0 to 0.32.0.
- [Release notes](https://github.com/Azure/azure-sdk-tools/releases)
- [Commits](https://github.com/Azure/azure-sdk-tools/commits)

* Remove lodash overrides from package.json

Removed overrides for lodash in package.json

* npm update --before 2026-04-10

* Add engines section to eng/common/tsp-client/package.json

Agent-Logs-Url: https://github.com/Azure/azure-sdk-tools/sessions/61e028bc-cf10-4896-81df-690436743c69

Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com>

* Reorder engines section in package.json

---------

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mike Harder <mharder@microsoft.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: mikeharder <9459391+mikeharder@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* Add SYSTEM_ACCESSTOKEN to Git release step

* Add SYSTEM_ACCESSTOKEN to publish-blobs.yml

---------

Co-authored-by: Ray Chen <raychen@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
)

Co-authored-by: Wes Haggard <Wes.Haggard@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 14, 2026

@copilot Rebase this PR to be against the latest code in the repo.

Rebased on latest main branch (commit 872c75a). The branch now includes all recent changes from main, and the deprecation documentation remains intact.

Copilot AI and others added 5 commits April 14, 2026 10:05
* Initial plan

* Add AGENTS.md file with comprehensive AI agent guidance

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Fix broken links - replace relative links with full GitHub URLs

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Replace non-ASCII characters with ASCII equivalents

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Update code generation section to reflect TypeSpec usage

Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>

* Fix C++ version references: repo targets C++14 only

Updated AGENTS.md to specify C++14 (not C++14 or higher/C++14+)
per LarryOsterman's review feedback — the Azure SDK for C++ does
not support versions higher than C++14.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: remove broken link to private typespec-cpp repo

The typespec-cpp repository is private, causing the link verification
CI check to fail with a 404. Remove the hyperlink while keeping the
text reference.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: Ronnie Geraghty <ronniegerag@gmail.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* adding support for soft deleted blobs and blob versions during resource cleanup

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Isabelle <ibrandes@microsoft.com>
Co-authored-by: Isabelle <141270045+ibrandes@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Copilot hook script to collect user prompt telemetry
Co-authored-by: Scott Beddall <scbedd@microsoft.com>
@RickWinter
Copy link
Copy Markdown
Member

@copilot the rebase is showing a lot of other changes. Check to ensure the PR changes are only the relevant changes for this work. Cleanup up the branch to be based on main. The diffs should only be your changes.

Copilot AI and others added 7 commits April 16, 2026 21:10
* Initial plan

* Add AGENTS.md file with comprehensive AI agent guidance

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Fix broken links - replace relative links with full GitHub URLs

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Replace non-ASCII characters with ASCII equivalents

Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>

* Update code generation section to reflect TypeSpec usage

Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>

* Fix C++ version references: repo targets C++14 only

Updated AGENTS.md to specify C++14 (not C++14 or higher/C++14+)
per LarryOsterman's review feedback — the Azure SDK for C++ does
not support versions higher than C++14.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: remove broken link to private typespec-cpp repo

The typespec-cpp repository is private, causing the link verification
CI check to fail with a 404. Remove the hyperlink while keeping the
text reference.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: Ronnie Geraghty <ronniegerag@gmail.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* adding support for soft deleted blobs and blob versions during resource cleanup

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Isabelle <ibrandes@microsoft.com>
Co-authored-by: Isabelle <141270045+ibrandes@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
* Copilot hook script to collect user prompt telemetry
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: Scott Beddall <scbedd@microsoft.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Add doc/deprecation.md with guidance on deprecating packages and APIs in
the Azure SDK for C++. Links to Azure SDK support policies without
duplicating content. Includes C++ specific patterns using [[deprecated]]
attributes and Doxygen conventions.

Updated README.md and CONTRIBUTING.md with links to the new guide.

Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 16, 2026

@copilot the rebase is showing a lot of other changes. Check to ensure the PR changes are only the relevant changes for this work. Cleanup up the branch to be based on main. The diffs ...

Fixed in 799fafc. The branch is now cleanly based on latest main (efdc2fe). The PR diff shows only the 3 relevant files: doc/deprecation.md, README.md, and CONTRIBUTING.md.

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.

Add document describing how to deprecate packages

9 participants