You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/deprecation_process.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,38 +36,30 @@ A disclaimer should be added indicating end-of-life date (EOLDate) of the packag
36
36
- 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).
37
37
-**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.
38
38
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.
40
40
41
41
- If a replacement package and migration guide exist:
42
42
43
43
```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.
47
45
```
48
46
49
47
- If a migration guide is not provided:
50
48
51
49
```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/).
55
51
```
56
52
57
53
- If a replacement package does not exist:
58
54
59
55
```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>.
63
57
```
64
58
65
59
- If a new service has replaced the service, and existing customers should be directed to the new service's Rest API docs/repo:
66
60
67
61
```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.
71
63
72
64
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.
73
65
```
@@ -244,6 +236,14 @@ Example of deprecated MS Learn API reference docs for Text Analytics [here](http
244
236
245
237
More detailed instructions on updating the CSV file can be found [here](https://eng.ms/docs/products/azure-developer-experience/develop/sdk-deprecation).
246
238
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
+
247
247
## Update overview/conceptual documentation that points to deprecated packages
248
248
249
249
TODO: The process for this section is still a WIP. Guidance will be updated here once we have concrete steps.
0 commit comments