Skip to content

docs(versioning): fix stable-after-preview guidance for @previewVersion ordering #4498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markcowl merged 4 commits into from
May 29, 2026
Merged

docs(versioning): fix stable-after-preview guidance for @previewVersion ordering #4498

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b95fe07
Initial plan
Copilot May 26, 2026
c529b1a
docs: fix stable-after-preview enum update guidance
Copilot May 26, 2026
6592e7a
docs: keep preview version in enum, remove only @previewVersion decor…
Copilot May 27, 2026
efe2597
Merge branch 'main' into copilot/fix-versioning-doc-inaccuracy
markcowl May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions website/src/content/docs/docs/howtos/Versioning/03-stable-after-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,16 @@ This includes the following steps:

## Making Changes to your TypeSpec spec

- Add a new entry to the versions enum for the new stable version
- Remove the `@previewVersion` decorator from the preview version and add the new stable version as the last entry in the enum

```diff lang=tsp
enum Versions {
- @Azure.Core.previewVersion
`2025-10-01-preview`,
+ `2026-01-01`,
}
```

- Update any mention in documentation of the old api-version to use the new api-version

```bash
Expand Down Expand Up @@ -73,15 +82,13 @@ This includes the following steps:
```

- Model any additional changes in the new stable version and mark with the appropriate versioning decorator, referencing the new stable version
- Remove the preview version from the version enum
- Remove the replaced preview version from the version enum

```diff lang=tsp
enum Versions {
- @Azure.Core.previewVersion
Comment thread
markcowl marked this conversation as resolved.
- `2025-10-01-preview`,
+ `2026-01-01`,
`2026-01-01`,
}

```

- Change the name of the `examples` version folder for the latest preview to match the new stable version
Expand Down
Loading