Skip to content

Commit 9ea7ea1

Browse files
authored
Update deprecation process doc for project archival (Azure#39707)
1 parent f8e9d2b commit 9ea7ea1

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/deprecation_process.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,38 +36,30 @@ A disclaimer should be added indicating end-of-life date (EOLDate) of the packag
3636
- The link to the migration guide should be a link in the format `https://aka.ms/azsdk/python/migrate/my-new-package`. To create this aka.ms link, follow the "How to create aka.ms links" section [here](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/233/Azure-SDK-AKA.ms-Links?anchor=how-to-create-aka.ms-links).
3737
- **NOTE**: You may decide to postpone or skip writing a migration guide based on downloads numbers (found on [pypistats](https://pypistats.org/), [pepy.tech](https://www.pepy.tech/), etc.) and internal knowledge of the usage of the package.
3838

39-
Replace ALL existing text with a disclaimer in the following format.
39+
The disclaimer should be added at the very top of the README.md before any other text in the following format.
4040

4141
- If a replacement package and migration guide exist:
4242

4343
```md
44-
# Microsoft Azure SDK for Python
45-
46-
This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-mynewpackage](https://pypi.org/project/azure-mynewpackage/). Refer to the migration guide (https://aka.ms/azsdk/python/migrate/my-new-package) for guidance on upgrading.
44+
**NOTE**: This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-mynewpackage](https://pypi.org/project/azure-mynewpackage/). Refer to the migration guide (https://aka.ms/azsdk/python/migrate/my-new-package) for guidance on upgrading.
4745
```
4846

4947
- If a migration guide is not provided:
5048

5149
```md
52-
# Microsoft Azure SDK for Python
53-
54-
This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-mynewpackage](https://pypi.org/project/azure-mynewpackage/).
50+
**NOTE**: This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. To receive updates on new features and non-security bug fixes, upgrade to the replacement package, [azure-mynewpackage](https://pypi.org/project/azure-mynewpackage/).
5551
```
5652

5753
- If a replacement package does not exist:
5854

5955
```md
60-
# Microsoft Azure SDK for Python
61-
62-
This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>.
56+
**NOTE**: This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>.
6357
```
6458

6559
- If a new service has replaced the service, and existing customers should be directed to the new service's Rest API docs/repo:
6660

6761
```md
68-
# Microsoft Azure SDK for Python
69-
70-
This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. Refer to the samples in the [My New Service repo](https://github.com/microsoft/my-new-service/tree/main) instead.
62+
**NOTE**: This package has been deprecated and will no longer be maintained after <EOLDate>. This package will only receive security fixes until <EOLDate>. Refer to the samples in the [My New Service repo](https://github.com/microsoft/my-new-service/tree/main) instead.
7163

7264
For additional support, open a new issue in the [Issues](https://github.com/microsoft/my-new-service/issues) section of the My New Service repo.
7365
```
@@ -244,6 +236,14 @@ Example of deprecated MS Learn API reference docs for Text Analytics [here](http
244236

245237
More detailed instructions on updating the CSV file can be found [here](https://eng.ms/docs/products/azure-developer-experience/develop/sdk-deprecation).
246238

239+
## Archive the project in PyPI
240+
241+
If the service is retired and customers should not expect to receive any future updates, including security fixes or maintenance, [your project can be marked as archived](https://blog.pypi.org/posts/2025-01-30-archival/). Before doing so, publish a final release with any necessary updates to the README/CHANGELOG/docs to warn customers that the project will not receive further updates.
242+
243+
To archive your project, reach out to Scott Beddall (scbedd). You cannot complete this step yourself.
244+
245+
Note: Project archival is not deletion. Archiving a project does not remove it from the index, and does not prevent users from installing it.
246+
247247
## Update overview/conceptual documentation that points to deprecated packages
248248

249249
TODO: The process for this section is still a WIP. Guidance will be updated here once we have concrete steps.

0 commit comments

Comments
 (0)