Skip to content

Commit 317bd4c

Browse files
committed
Updates.
1 parent bb253fa commit 317bd4c

4 files changed

Lines changed: 19 additions & 4 deletions

File tree

.github/workflows/src/api-md-consistency/api-md-consistency.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ function formatIssueSection(title, apiFiles) {
4444
const packageName = path.basename(packageDir);
4545
lines.push(`- ${packageDir}`);
4646
lines.push(` API file: ${apiFile}`);
47-
lines.push(` Regenerate: azpysdk apistub --md --extract-metadata ${packageName}`);
47+
lines.push(` Regenerate: azpysdk apistub --md --extract-metadata ${packageName} --dest-dir ${packageDir}`);
4848
}
4949
lines.push("");
5050
return lines.join("\n");

scripts/api_md_workflow/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ It runs on pull requests for changes under `sdk/**`.
2222
- Regenerates `api.md` for those packages.
2323
- Fails if the generated files differ from the committed files.
2424
- Fails if an affected package does not have a committed `api.md`.
25-
- Prints the mismatched or missing packages and the `azpysdk apistub --md --extract-metadata` command needed to regenerate each `api.md` file.
25+
- Prints the mismatched or missing packages and the `azpysdk apistub --md --extract-metadata <package-name> --dest-dir <package-dir>` command needed to regenerate each `api.md` file.
2626

2727
## Script Layout
2828

@@ -49,7 +49,7 @@ Also writes `count=<n>` to `GITHUB_OUTPUT`.
4949

5050
### `regenerate.js`
5151

52-
Reads package directories from `API_MD_PACKAGES_FILE` and runs `azpysdk apistub --md --extract-metadata <package-name>` for each package.
52+
Reads package directories from `API_MD_PACKAGES_FILE` and runs `azpysdk apistub --md --extract-metadata <package-name> --dest-dir <package-dir>` for each package.
5353

5454
This script is used by the consistency check.
5555

@@ -100,4 +100,4 @@ Common variables include:
100100
3. `find_affected.js` determines which packages were touched.
101101
4. `regenerate.js` rebuilds `api.md` for those packages.
102102
5. `find_mismatches.js` records any `api.md` drift, including missing or untracked `api.md` files.
103-
6. If drift is found, the workflow fails and prints the affected packages plus the `azpysdk apistub --md --extract-metadata <package-name>` command to regenerate each `api.md` file locally.
103+
6. If drift is found, the workflow fails and prints the affected packages plus the `azpysdk apistub --md --extract-metadata <package-name> --dest-dir <package-dir>` command to regenerate each `api.md` file locally.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
```py
2+
namespace azure.template
3+
4+
def azure.template.template_main() -> bool: ...
5+
6+
7+
namespace azure.template.template_code
8+
9+
def azure.template.template_code.template_main() -> bool: ...
10+
11+
12+
```
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
apiMdSha256: 9b0fa6154e3a859680da1a07f5106508983884de567522c5166fc57bacb9cb00
2+
parserVersion: 0.3.28
3+
pythonVersion: 3.12.9

0 commit comments

Comments
 (0)