Skip to content

Commit

Permalink
Update deprecation_process.md (#38270)
Browse files Browse the repository at this point in the history
Adding a section on:
- adding the artifact to the ci before release
- skipping checks for other failing packages in the pipeline for release if needed
  • Loading branch information
swathipil authored Nov 1, 2024
1 parent c130cf4 commit 0ba364c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .vscode/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,9 @@
"azurecr",
"azuremgmtcore",
"azuremgmtcommunication",
"azuremypackage",
"bdist",
"Beddall",
"bstr",
"byref",
"cdll",
Expand Down Expand Up @@ -241,8 +243,10 @@
"fileno",
"fqdns",
"fstat",
"Ganguly",
"gbps",
"GCCH",
"Geraghty",
"getsizeof",
"graphrbac",
"gmtime",
Expand Down Expand Up @@ -319,6 +323,8 @@
"myacr",
"mydirectory",
"myfile",
"mynewpackage",
"mypackage",
"myvault",
"mytable",
"nazsdk",
Expand All @@ -343,6 +349,7 @@
"ownerid",
"PBYTE",
"PCREDENTIAL",
"pepy",
"perfmon",
"perfstress",
"perfstressdebug",
Expand Down Expand Up @@ -371,6 +378,9 @@
"pyversion",
"RAGRS",
"rdbms",
"rgeraghty",
"Rohit",
"rohitganguly",
"reauthenticated",
"reimage",
"revascularization",
Expand Down Expand Up @@ -446,6 +456,7 @@
"volcz",
"vsts",
"wchar",
"wesh",
"westcentralus",
"westus",
"wfile",
Expand Down
18 changes: 18 additions & 0 deletions doc/deprecation_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,20 @@ Replace ALL existing text with a disclaimer in the following format.

- Update the `Development Status` classifier in `setup.py` to `Development Status :: 7 - Inactive`.
- `Inactive` packages are disabled from most CI verification such as tests/mypy/pylint/etc., therefore the CI should be faster and have fewer requirements.

## ci.yml

- Ensure the package is listed under `Artifacts` so that the artifact is generated for release. If not listed, add it.

```yml
extends:
parameters:
...
Artifacts:
- name: azure-mypackage
safeName: azuremypackage
```
# Step 2: Resolve all open issues/PRs corresponding to the library.
Expand Down Expand Up @@ -145,6 +159,10 @@ A release here is the same as usual, triggering the release pipeline of your SDK

**Note: This release DOES NOT need to be done during during release week and can be done any time.**

### Checks Failing on Other Packages

You may see tests/mypy/pylint or other checks failing on other packages in the CI when releasing. To unblock the release of the deprecated package, you may add one or more `Skip.*` variables when you 'Run pipeline' to skip these checks. The `Skip.*` variables for all checks are listed [here](https://github.com/Azure/azure-sdk-for-python/blob/dc283ae7e8f7fe3bb1db8f27315d589e88bdf453/doc/eng_sys_checks.md?plain=1#L76).

## Post-Release

Check to make sure that the new version of the package has been released on PyPI.
Expand Down

0 comments on commit 0ba364c

Please sign in to comment.