Skip to content

Automate SchemaStore PR creation for new minor/major releases #5017

Description

@arturcic

Summary

Automate updating the GitVersion JSON schema entry on SchemaStore/schemastore whenever a new GitVersion version with a new schema is released, following the pattern of SchemaStore/schemastore#5485.

Currently this update is done manually after each release that ships a new schema version. It should be automated instead.

What the SchemaStore PR does

For a new version X.Y, it:

  1. Adds "X.Y": "https://gitversion.net/schemas/X.Y/GitVersion.configuration.json" to the versions map for the GitVersion entry in src/api/json/catalog.json.
  2. Bumps the top-level "url" for that entry to point at the new X.Y schema.
  3. Updates the $ref in src/schemas/json/gitversion.json to point at the new X.Y schema URL.

Acceptance criteria

  • When a new schema version is published, a PR is automatically opened on SchemaStore/schemastore updating catalog.json and gitversion.json for the new version, without manual intervention.
  • Releases that don't introduce a new schema version don't trigger a SchemaStore PR.
  • It's possible to trigger the update manually for a specific version, in case the automatic detection is missed or needs to be re-run.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions