BUILD-11458 Add release channel pointer JSON schema

[jayadeep-km-sonarsource]

BUILD-11458 — first task of epic BUILD-11447 (update-release-channel action for binary release channel pointers).

What

Adds the JSON Schema (draft-07) for the per-channel pointer JSON that the upcoming update-release-channel action will write to s3://downloads-cdn-eu-central-1-prod/<prefix>/<product>/<channel>.json.

• update-release-channel/schema/v1.json — schema definition
• update-release-channel/schema/README.md — versioning policy and field reference

Schema shape

Field	Type	Required
schemaVersion	integer (const 1)	yes
version	string	yes
updatedAt	ISO-8601 / RFC 3339 UTC string	yes

additionalProperties: true — consumers MUST ignore unknown fields. This lets us add optional fields later (e.g. per-platform artifact URLs, signature metadata) without bumping the schema version. A new file (v2.json) is only introduced for non-backwards-compatible changes; the in-document schemaVersion stays in lockstep with the filename.

Path convention

Action directory lives at the repo root (update-release-channel/) to match the existing convention in this repo (promote/, cache/, build-gradle/, ...). The spec mentioned .github/actions/update-release-channel/ but CONTRIBUTE.md documents top-level placement.

Validation

No sample fixtures are checked in. Validation against real action outputs lands with:

• Writer unit tests — BUILD-11460
• Integration test workflow — BUILD-11461

Both will pipe the dry-run JSON body through check-jsonschema against v1.json.

Not in scope

Action code, workflows, README for the action, and pilot wiring — those land in the follow-up tickets (BUILD-11459 through BUILD-11464). Draft until those are at least in flight.

[hashicorp-vault-sonar-prod]

BUILD-11458

[Copilot]

Pull request overview

Introduces the v1 JSON Schema (draft-07) and accompanying README for the per-channel release pointer JSON that the future update-release-channel GitHub Action will publish to S3. This is a docs/schema-only change; action code, tests, and wiring (shellspec, sonar, root README index) intentionally land in follow-up tickets.

Changes:

• Adds update-release-channel/schema/v1.json defining required fields schemaVersion (const 1), version (non-empty string), and released_at (date-time string with regex).
• Adds update-release-channel/schema/README.md documenting versioning policy, field reference, and validation plan.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
update-release-channel/schema/v1.json	New draft-07 JSON Schema for the release channel pointer document.
update-release-channel/schema/README.md	Documentation of schema versioning policy and field semantics.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues
0 New dependency risks

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[gitar-bot]

Code Review ✅ Approved 1 resolved / 1 findings

Introduces the JSON schema and versioning policy for release channel pointers to support upcoming automation. No issues found.

✅ 1 resolved

✅ Edge Case: released_at pattern allows non-UTC offsets despite UTC requirement

📄 update-release-channel/schema/v1.json:24
The description and README both state the timestamp must be UTC, but the regex pattern (?:Z|[+-]\d{2}:\d{2}) accepts arbitrary timezone offsets (e.g. +05:30). This means a non-UTC value like 2026-05-01T10:00:00+05:30 would pass schema validation, violating the documented invariant.

If the intent is strict UTC-only, tighten the pattern to accept only Z (and optionally +00:00).

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply	Compact
gitar auto-apply:on	gitar display:verbose

_{Was this helpful? React with 👍 / 👎 | Gitar}