changelog-promotion-bundle: optional explicit version for version-keyed products (ECE) - #286
Open
cotti wants to merge 1 commit into
Open
changelog-promotion-bundle: optional explicit version for version-keyed products (ECE)#286cotti wants to merge 1 commit into
cotti wants to merge 1 commit into
Conversation
…ed products Date-promotion products default to the derived UTC run date, but not every promotion-triggered product publishes date-keyed notes: ECE's release notes are V.R.M-keyed (e.g. 4.2.0). Add an optional 'version' input — validated as semver-or-ISO-date via env, never interpolated — used instead of the derived date when provided. Omitted input keeps today's behavior for serverless/ECH.
|
Label error. Requires exactly 1 of: automation, breaking, bug, changelog:skip, chore, ci, dependencies, documentation, enhancement, feature, fix. Found: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Why
Review feedback on elastic/cloud#157943 (lcawl): ECE's published release notes are V.R.M-keyed (e.g.
4.2.0— see the live page), but the shared promotion workflow unconditionally derives the UTC run date as the bundle version. The docs-builder CLI already supports an explicit version with commit ranges — only this wrapper restricted it.What
Adds an optional
versioninput tochangelog-promotion-bundle.yml:4.2.0, pre-release suffixes allowed) or ISO date, then used as the bundle version. Validation happens viaenvwith a strict regex — the input is never interpolated into the script and a malformed value fails the run with a clear error.Header comment updated: the workflow covers promotion-triggered products generally; date-keyed is the default, not the definition.
Consumer
elastic/cloud#157943's caller gains a matching optional
versionfield so ECE dispatches can pass4.2.x. Part of docs-eng-team#741 Track 4.