Azure / Azure/azure-sdk-tools

[Spec PR] stable and preview should not have the same date label

Open
#14,982 0 comments 0 reactions 0 assignees View on GitHub
Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

The issue is to propose a check of API version label, ensuring stable and preview should not share the same date in the version label.

Firstly, according to [Azure REST API Guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning), there is a clear guidance - "_DO NOT use the same date when transitioning from a preview API to a GA API. If the preview api-version is '2021-06-04-preview', the GA version of the API must be a date later than 2021-06-04_".

From SDK perspective, when a service request SDK releases upon a stable API version and a preview API version sharing the same date-based version label, it becomes difficult to determine which version is newer.

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Start by reading the linked Azure REST API Guidelines section on API versioning, then locate how this repository currently validates API version labels. Done means the proposed check distinguishes stable and preview versions and rejects labels that use the same date.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.