Skip to content
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.

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

Add check Uniform Versioning Validation #29065

Open
mikeharder opened this issue May 10, 2024 · 4 comments
Open

Add check Uniform Versioning Validation #29065

mikeharder opened this issue May 10, 2024 · 4 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.

Comments

@mikeharder
Copy link
Member

mikeharder commented May 10, 2024

  • Pipeline uses GH Action
  • Tool is clone of TypeSpecValidation
  • Rules
    • Verify default $(tag) exists
    • Add more rules we can think of now, or as we find more bugs in specs
  • Support suppressions.yaml
  • Run on PRs to give clear guidance how to fix readme.md
  • Run on all specs in main
    • If only a few failures, add suppressions then enable pipeline "ReadmeValidation - All"

Notes from @konrad-jamrozik

A quickstart guide I wrote for creating such checks is here:

Closely related to:

@konrad-jamrozik
Copy link

konrad-jamrozik commented May 10, 2024

Avocado was in effect our "README validation" check before. There is bunch of work related to it:

The README validation ideally should build directly on this work (once ready):

For suppressions, we probably should also support the README.md suppressions and sdk-suppressions.yaml:

@konrad-jamrozik
Copy link

I had a chat with @mikeharder. We are considering introducing a check named Uniform Versioning Validation. It would take care of directory structure validation and README.md validation, ensuring, among others, that they follow the uniform versioning principles as outlined in this PR:

@konrad-jamrozik konrad-jamrozik added Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo. labels Jun 4, 2024
@konrad-jamrozik konrad-jamrozik moved this to 📋 Backlog in Spec PR Tools Jun 7, 2024
@konrad-jamrozik
Copy link

A related work that will require understanding spec dir structure is checking if a PR is an "incremental TypeSpec" PR:

@konrad-jamrozik konrad-jamrozik changed the title Add check ReadmeValidation Add check Uniform Versioning Validation Jun 11, 2024
@konrad-jamrozik
Copy link

Some desired checks from @josefree :

For "uniform versioning", it would be great if there could be automatic check, and pop-up error in spec PR pipeline. For example,

  • The service version ❗must❗ be always represented in its entirety; any SDK or documentation referring to the service must encompass all of it.

and

  • stable and preview API versions ❗cannot❗ have the same date.
  • Moving to stable from preview by removing -preview suffix is ❗not allowed❗.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.
Projects
Status: 📋 Backlog
Status: 📋 Backlog
Development

No branches or pull requests

2 participants