-
Notifications
You must be signed in to change notification settings - Fork 1
BUILD-11458 Add release channel pointer JSON schema #272
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
Merged
jayadeep-km-sonarsource
merged 1 commit into
master
from
feat/jd/BUILD-11458-releaseChannelSchema
May 28, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Release channel pointer schema | ||
|
|
||
| JSON Schema for the per-channel pointer file written by the `update-release-channel` GitHub Action to | ||
| `s3://downloads-cdn-eu-central-1-prod/<prefix>/<product>/<channel>.json`. | ||
|
|
||
| ## Versioning | ||
|
|
||
| The schema version lives in the **filename** (`v1.json`, `v2.json`, ...) and in lockstep in the `schemaVersion` field | ||
| inside the JSON document. | ||
|
|
||
| A new file (e.g. `v2.json`) is introduced **only** when existing fields are removed, renamed, or changed in a | ||
| non-backwards-compatible way. Additive changes (new optional fields) ship as updates to `v1.json` — consumers MUST | ||
| ignore unknown fields. | ||
|
|
||
| ## v1 fields | ||
|
|
||
| | Field | Type | Required | Description | | ||
| | --------------- | ------- | -------- | ------------------------------------------------------------------------ | | ||
| | `schemaVersion` | integer | yes | Const `1`. | | ||
| | `version` | string | yes | Currently published version on this channel (e.g. `0.9.0.977`). | | ||
| | `updatedAt` | string | yes | ISO-8601 UTC timestamp at which the channel was promoted to `version`. | | ||
|
|
||
| `additionalProperties: true` — unknown fields are accepted and MUST be ignored by older consumers. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "$id": "https://raw.githubusercontent.com/SonarSource/ci-github-actions/master/update-release-channel/schema/v1.json", | ||
| "title": "Release Channel Pointer (v1)", | ||
| "description": "Per-channel release pointer JSON. Consumers MUST ignore unknown fields.", | ||
| "type": "object", | ||
| "required": ["schemaVersion", "version", "updatedAt"], | ||
| "additionalProperties": true, | ||
| "properties": { | ||
| "schemaVersion": { | ||
| "description": "Schema version. Bumped only on non-backwards-compatible changes; additive evolution stays at 1.", | ||
| "type": "integer", | ||
| "const": 1 | ||
| }, | ||
| "version": { | ||
| "description": "Currently published version on this channel (e.g. \"0.9.0.977\", \"2026.1.0\").", | ||
| "type": "string", | ||
| "minLength": 1 | ||
| }, | ||
| "updatedAt": { | ||
| "description": "ISO-8601 / RFC 3339 UTC timestamp at which this channel was promoted to point at `version`.", | ||
| "type": "string", | ||
| "format": "date-time", | ||
| "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$" | ||
|
jayadeep-km-sonarsource marked this conversation as resolved.
|
||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.