Azure / Azure/apiops-cli

[Doc Drift] README extract flags table missing `--remove-stale`

未关闭 适合新手
#250 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
type:documentation
主要语言
TypeScript
星标
26
派生
9
平均合并
1 天 3 小时
30 天内合并 PR
20

描述

### What drifted

The `apiops extract` flags table in `README.md` is missing the `--remove-stale` flag. The flag exists in the CLI (confirmed by `apiops extract --help`) and is documented in `docs/commands/extract.md`, but was not added to the README summary table when it was introduced in commit `570ca00` ("fix: reconcile stale extraction artifacts safely").

### Source of truth

`apiops extract --help` output:
```
--remove-stale Remove stale managed artifacts in the selected scope
```

`docs/commands/extract.md` line 69:
```
| `--remove-stale` | boolean | false | No | Remove stale managed artifacts in the selected filter and workspace scope after a fully successful extraction |
```

### Affected documentation

- `README.md` — the `### \`apiops extract\`` section's flags table (currently lists only `--resource-group`, `--service-name`, `--output`, `--filter`, `--no-transitive`)

### Suggested update

Add a row for `--remove-stale` to the README extract flags table:

| `--remove-stale` | | Remove stale managed artifacts after a fully successful extraction |

> Generated by [Documentation Freshness Check — System Policy](https://github.com/Azure/apiops-cli/actions/runs/33410933190) · 38.1 AIC · ⌖ 6.97 AIC · ⊞ 6.2K · [◷](https://github.com/search?q=repo%3AAzure%2Fapiops-cli+is%3Aissue+%22gh-aw-workflow-call-id%3A+Azure%2Fapiops-cli%2Fdoc-freshness%22&type=issues)

贡献指南

打开贡献指南

调研方向

Start with the `apiops extract` flags table in `README.md`, then compare it with `docs/commands/extract.md` line 69 and the `apiops extract --help` output mentioned in the issue. Done means the README table includes `--remove-stale` with wording consistent with the documented behavior.

由索引模型根据 Issue 内容生成。

评估

领域
cli, documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
活跃
描述清晰度
描述清楚
新手友好度
94/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。