Skip to content

Commit c78ea56

Browse files
swathipilallenkim0129
authored andcommitted
Update deprecation_process.md for Verify Readmes failure (Azure#38333)
Adding a section for Verify Readmes failure following Azure#37975 .
1 parent a726059 commit c78ea56

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/deprecation_process.md

+10
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ Wait for the CI to run. Fix any issues related to deprecation in the PR, such as
130130

131131
There should not be any tests or mypy/pylint/etc. failures as these checks are disabled on `Inactive` packages.
132132

133+
### Verify Readmes Failure
134+
135+
If you see the "Verify Readmes" task in the "Analyze" job failing with `There were README verification failures, scroll up to see the issue(s)`, add a line to ignore the package in [`eng/.docsettings.yml` under `known_content_issues`](https://github.com/Azure/azure-sdk-for-python/blob/5136a43ac2c841e6ffe36f55df6c94f1ddd00a9d/eng/.docsettings.yml#L41). For example:
136+
137+
```yml
138+
known_content_issues:
139+
...
140+
- ['sdk/mypackage/azure-mypackage/README.md', '#4554']
141+
```
142+
133143
## Post your PR in the Python review channel
134144

135145
Post your PR in the [review channel for Python](https://teams.microsoft.com/l/channel/19%3a4175567f1e154a80ab5b88cbd22ea92f%40thread.skype/Language%2520-%2520Python%2520-%2520Reviews?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47) for verification that all requirements for deprecation have been met. If you are not the codeowner, please explicitly tag the codeowner in the post for approval.

0 commit comments

Comments
 (0)