Commit f6e42f0
Fix stale typespec-ts modular-unit snapshot after ARM doc changes (Azure#4795) (Azure#4796)
## Why
PR Azure#4494 ("Improve documentation for ARM library decorators, interfaces,
and models") added `@doc("")` to the ARM `ArmResourceActionAsync`
operation template, so those operations no longer emit a public doc
comment. Because Azure#4494 did not touch `packages/typespec-ts/**`,
`ci-typescript.yml` never ran on it, and the stale `modular-unit`
scenario snapshot landed on `main` unnoticed. This made the
**typespec-ts / CI -> Run unit tests** job red on `main` and on every
typespec-ts PR (including Azure#4788).
## What changed
- Updated the `bodyOptionalParameterName.md` modular-unit scenario to
drop the now-empty ARM operation doc comment (`/** A long-running
resource action. */`) and the corresponding sample summary text,
matching what the current ARM library emits.
- Added an `internal` chronus changeset for `@azure-tools/typespec-ts`.
## Notes for reviewers
- The drift was narrower than the issue implied. Only
`bodyOptionalParameterName.md` actually failed: its `backup` op uses
`ArmResourceActionAsync` (which got `@doc("")`). `lroPaging.md` still
passes because its `suspend` op uses `ArmResourceActionAsyncBase`, which
Azure#4494 left with a public doc, so it correctly still emits `A
long-running resource action.`
- I did not commit the full `SCENARIOS_UPDATE=true` output. Write mode
reformats every scenario through prettier and produced 46 changed files
(+1039/-763), but 44 of those were pure formatting noise: the runner's
assertion is whitespace-normalized (`ignoreWeirdLine`), so those never
actually failed. I discarded the noise and hand-applied only the 3
genuine doc removals to keep the diff minimal and reviewable.
## Verification
- `pnpm unit-test` -> 657 passed
- `pnpm test-next` -> 252 passed
- `pnpm chronus verify` -> clean
- prettier `--check` on changed files -> clean
## Follow-up (out of scope)
ARM library (`typespec-azure-resource-manager`) changes can alter
typespec-ts emitted output but do not trigger `ci-typescript.yml`, so
this drift class can recur. Consider widening the workflow `paths`
triggers to include the emitter's TypeSpec library dependencies. Tracked
separately.
Fixes: Azure#4795
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: JialinHuang803 <139532647+JialinHuang803@users.noreply.github.com>1 parent cd9c422 commit f6e42f0
2 files changed
Lines changed: 10 additions & 3 deletions
File tree
- .chronus/changes
- packages/typespec-ts/test/modular-unit/scenarios/samples/parameters
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
190 | 190 | | |
191 | 191 | | |
192 | 192 | | |
193 | | - | |
| 193 | + | |
194 | 194 | | |
195 | 195 | | |
196 | 196 | | |
| |||
217 | 217 | | |
218 | 218 | | |
219 | 219 | | |
220 | | - | |
| 220 | + | |
221 | 221 | | |
222 | | - | |
| 222 | + | |
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
| |||
0 commit comments