Skip to content

Commit b847310

Browse files
update to health report doc (Azure#38786)
1 parent 7a78f58 commit b847310

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

doc/repo_health_status.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The health report is broken down into the following sections:
2626
- [Sphinx](#sphinx-required-check)
2727
- [Tests - CI](#tests---ci-required-check)
2828
- [Tests - Live](#tests---live)
29+
- [Tests - Samples](#tests---samples)
2930
- [Pyright](#pyright)
3031
- [Type check samples](#type-check-samples)
3132
- [SLA - Bugs](#sla---bugs)
@@ -38,7 +39,7 @@ This is the overall status of your library and indicates whether you can release
3839

3940
- $${\color{red}BLOCKED}$$ - your library is currently blocked from release. It is failing required/mandatory checks (marked in red) or has its CI disabled due to non-compliance with required checks.
4041

41-
If your CI has been disabled, please take action to re-enable and fix all checks highlighted in yellow. Once all checks are fixed, you can remove the `ci_enabled=false` from your library's pyrpoject.toml file.
42+
If your CI has been disabled, please take action to re-enable and fix all checks highlighted in yellow. Once all checks are fixed, you can remove the `ci_enabled=false` from your library's pyproject.toml file.
4243

4344
- $${\color{yellow}NEEDS \space ACTION}$$ - your library is not blocked from release today, but if action(s) are not taken, it may be blocked in the near future. Please take action to fix/re-enable any checks highlighted in yellow.
4445

@@ -48,57 +49,66 @@ This is the overall status of your library and indicates whether you can release
4849

4950
[MyPy](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#mypy) is a static type checker, and is mandatory to run on the source code of all libraries. To learn more about static type checking in our repo, see our [Static Type Checking Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking.md). Possible statuses include:
5051

51-
- $${\color{red}FAILED}$$ - The library is failing the MyPy check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
52+
- $${\color{red}FAIL}$$ - The library is failing the MyPy check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
5253
- $${\color{yellow}DISABLED}$$ - MyPy is not enabled for your library in the pyproject.toml file. This is a required check and must be enabled. If not enabled, your library will be blocked from release in the near future.
5354
- $${\color{yellow}WARNING}$$ - The library passes the currently pinned version of MyPy in the repo, but is failing the next-mypy check (the next version of MyPy the repo will be bumped to in the near future). Please fix these errors before the merge date of the next version of MyPy or the errors will begin to fail the build (See [analyze_check_versions.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/analyze_check_versions.md)) to understand target dates for version bumps.
54-
- $${\color{green}GOOD}$$ - The library passes both current MyPy and next-MyPy.
55+
- $${\color{green}PASS}$$ - The library passes both current MyPy and next-MyPy.
5556
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
5657

5758
### Pylint (required check):
5859

5960
[Pylint](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#pylint) is a linter, and is mandatory to run on all libraries. To learn more about linting in our repo, see our [Pylint Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/pylint_checking.md). Possible statuses include:
6061

61-
- $${\color{red}FAILED}$$ - The library is failing the Pylint check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
62+
- $${\color{red}FAIL}$$ - The library is failing the Pylint check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
6263
- $${\color{yellow}DISABLED}$$ - Pylint is not enabled for your library in the pyproject.toml file. This is a required check and must be enabled. If not enabled, your library will be blocked from release in the near future.
6364
- $${\color{yellow}WARNING}$$ - The library passes the currently pinned version of Pylint in the repo, but is failing the next-pylint check (the next version of Pylint the repo will be bumped to in the near future). Please fix these errors before the merge date of the next version of Pylint or the errors will begin to fail the build (See [analyze_check_versions.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/analyze_check_versions.md)) to understand target dates for version bumps.
64-
- $${\color{green}GOOD}$$ - The library passes both current Pylint and next-Pylint.
65+
- $${\color{green}PASS}$$ - The library passes both current Pylint and next-Pylint.
6566
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
6667

6768
### Sphinx (required check):
6869

6970
[Sphinx](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#sphinx-and-docstring-checker) is a tool which builds/validates our documentation, and is mandatory to run on all libraries. To learn more about Sphinx/docstrings in our repo, see [Docstrings](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/docstring.md). Possible statuses include:
7071

71-
- $${\color{red}FAILED}$$ - The library is failing the Sphinx check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
72+
- $${\color{red}FAIL}$$ - The library is failing the Sphinx check. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
7273
- $${\color{yellow}DISABLED}$$ - Sphinx is not enabled for your library in the pyproject.toml file. This is a required check and must be enabled. If not enabled, your library will be blocked from release in the near future.
73-
- $${\color{green}GOOD}$$ - The library passes Sphinx.
74+
- $${\color{green}PASS}$$ - The library passes Sphinx.
7475
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
7576

7677
### Tests - CI (required check):
7778

7879
[Tests - CI](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#pr-validation-tox-test-environments) checks the status of the most recent (python - {service-directory})scheduled build of your library's recorded tests. This is the same CI that will run when triggering a release build. To learn more about tests in our repo, see our [Testing Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md). Possible statuses include:
7980

80-
- $${\color{red}FAILED}$$ - The library is failing CI recorded tests. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
81+
- $${\color{red}FAIL}$$ - The library is failing CI recorded tests. Check the build result and address the errors present. This will block the release of your library and should be fixed immediately.
8182
- $${\color{yellow}DISABLED}$$ - The library has its CI disabled due to non-compliance with required checks. Please take action to re-enable and fix all checks highlighted in yellow. Once all checks are fixed, you can remove the `ci_enabled=false` from your library's pyproject.toml file.
82-
- $${\color{green}GOOD}$$ - The library passes CI recorded tests.
83+
- $${\color{green}PASS}$$ - The library passes CI recorded tests.
8384
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
8485

8586
### Tests - Live:
8687

87-
[Tests - Live](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#nightly-live-checks) checks the status of the most recent (python - {service-directory} - tests)scheduled build of your library's live tests. To learn more about setting up live tests in our repo, see our [Testing Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md). Possible statuses include:
88+
[Tests - Live](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#nightly-live-checks) checks the status of the most recent (python - {service-directory} - tests) scheduled build of your library's live tests. To learn more about setting up live tests in our repo, see our [Testing Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md). Possible statuses include:
8889

89-
- $${\color{red}FAILED}$$ - The library is failing live tests. Errors should be investigated and fixed promptly to ensure there are no issues with releasing the current state of your library.
90+
- $${\color{red}FAIL}$$ - The library is failing live tests. Errors should be investigated and fixed promptly to ensure there are no issues with releasing the current state of your library.
9091
- $${\color{yellow}DISABLED}$$ - The library has its CI disabled due to non-compliance with required checks. Please take action to re-enable and fix all checks highlighted in yellow. Once all checks are fixed, you can remove the `ci_enabled=false` from your library's pyproject.toml file.
91-
- $${\color{green}GOOD}$$ - The library passes live tests.
92+
- $${\color{green}PASS}$$ - The library passes live tests.
93+
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
94+
95+
### Tests - Samples:
96+
97+
[Tests - Samples](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/sample_guide.md#test-run-samples-in-ci-live-tests) checks the status of the most recent (python - {service-directory} - tests) scheduled build of your library's live run against the samples directory. To learn more about setting up sample tests in our repo, see our [Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#running-samples). Possible statuses include:
98+
99+
- $${\color{red}FAIL}$$ - The library is failing sample tests. Errors should be investigated and fixed promptly to ensure there are no issues with releasing the current state of your library.
100+
- $${\color{yellow}DISABLED}$$ - The library has its CI disabled due to non-compliance with required checks. Please take action to re-enable and fix all checks highlighted in yellow. Once all checks are fixed, you can remove the `ci_enabled=false` from your library's pyproject.toml file.
101+
- $${\color{green}PASS}$$ - The library passes sample tests.
92102
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
93103

94104
### Pyright:
95105

96106
[Pyright](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md#pyright) is a static type checker, and is recommended to run on the source code of all libraries. To learn more about static type checking in our repo, see our [Static Type Checking Guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking.md). Possible statuses include:
97107

98-
- $${\color{red}FAILED}$$ - Pyright is enabled for the library and the library is failing the check. This will block the release of your library and should be fixed immediately.
108+
- $${\color{red}FAIL}$$ - Pyright is enabled for the library and the library is failing the check. This will block the release of your library and should be fixed immediately.
99109
- $${\color{yellow}DISABLED}$$ - Pyright is not enabled for your library in the pyproject.toml file.
100110
- $${\color{yellow}WARNING}$$ - Pyright is enabled for the library and the library passes the currently pinned version of Pyright in the repo, but is failing the next-pyright check (the next version of Pyright the repo will be bumped to in the near future). Please fix these errors before the merge date of the next version of Pyright or the errors will begin to fail the build (See [analyze_check_versions.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/analyze_check_versions.md)) to understand target dates for version bumps.
101-
- $${\color{green}GOOD}$$ - The library passes both current Pyright and next-pyright.
111+
- $${\color{green}PASS}$$ - The library passes both current Pyright and next-pyright.
102112
- $${\color{black}UNKNOWN}$$ - A result was not available for the most recent scheduled build. This could be due to an upstream pipeline failure preventing this particular check from running or a missing pipeline. Please ensure your pipeline builds are free of errors so that a Status for your library can be determined.
103113

104114
### Type check samples:

0 commit comments

Comments
 (0)