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/eng_sys_checks.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@
5
5
-[Skipping a check at build queue time](#skipping-a-check-at-build-queue-time)
6
6
-[Skipping entire sections of builds](#skipping-entire-sections-of-builds)
7
7
-[The pyproject.toml](#the-pyprojecttoml)
8
+
-[Required Metadata](#required-metadata)
8
9
-[Coverage Enforcement](#coverage-enforcement)
9
10
-[Environment variables important to CI](#environment-variables-important-to-ci)
10
11
-[Atomic Overrides](#atomic-overrides)
@@ -140,6 +141,28 @@ black = false
140
141
141
142
If a package does not yet have a `pyproject.toml`, creating one with just the section `[tool.azure-sdk-build]` will do no harm to the release of the package in question.
142
143
144
+
### Required Metadata
145
+
146
+
Packages with a stable GA release must have a `[tool.azure-sdk-conda]` section in their `pyproject.toml`.
147
+
- This section defines if the package is released individually to Conda, or grouped with other packages in one release bundle (see [conda-release.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/conda-release.md)).
148
+
- The `[tool.azure-sdk-conda]` table **must** include an `in_bundle` key (boolean) indicating whether the package is part of a bundle. When `in_bundle = true`, a `bundle_name` key is also **required** so the conda tooling can map the package into the correct bundle.
149
+
- The presence and correctness of these keys is enforced by the `verifywhl` CI check. Service teams are responsible for updating this metadata.
150
+
151
+
Here are examples:
152
+
153
+
```toml
154
+
# Package is released to Conda individually
155
+
[tool.azure-sdk-conda]
156
+
in_bundle = false
157
+
```
158
+
159
+
```toml
160
+
# Package is released within the `azure-communication` bundle
161
+
[tool.azure-sdk-conda]
162
+
in_bundle = true
163
+
bundle_name = "azure-communication"
164
+
```
165
+
143
166
### Coverage Enforcement
144
167
145
168
This repository supports enforcement of an absolute coverage % per package. Set:
Copy file name to clipboardExpand all lines: eng/tools/azure-sdk-tools/azpysdk/verify_whl.py
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -127,13 +127,14 @@ def verify_conda_section(
127
127
config=parsed_pkg.get_conda_config()
128
128
ifnotconfig:
129
129
logger.error(
130
-
f"Package {package_name} has a stable version on PyPI but is missing "
131
-
"[tool.azure-sdk-conda] section in pyproject.toml. This section is required to "
132
-
"specify if the package should be released individually or bundled to Conda."
130
+
f"Package {package_name} has a stable version on PyPI but is missing required"
131
+
"[tool.azure-sdk-conda] section in pyproject.toml. See https://aka.ms/azsdk/python/conda/pyproject for instructions."
133
132
)
134
133
returnFalse
135
134
elif"in_bundle"notinconfig:
136
-
logger.error(f"[tool.azure-sdk-conda] section in pyproject.toml is missing required field `in_bundle`.")
135
+
logger.error(
136
+
f"[tool.azure-sdk-conda] section in pyproject.toml is missing required field `in_bundle`. See https://aka.ms/azsdk/python/conda/pyproject for instructions."
137
+
)
137
138
returnFalse
138
139
logger.info(f"Verified conda section for package {package_name}")
0 commit comments