-
Notifications
You must be signed in to change notification settings - Fork 43
feat(changelog): resolve Lisa's review on #789 — versions, amend reconciler, backport rule #3939
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
fb36e36
feat(changelog): resolve Lisa's review on #789 — versions, amend reco…
Mpdreamz f5a5656
style: dotnet format BundleCdnSourcingTests
Mpdreamz 609c983
style: add lang=json,strict comment to RegistryJson constant
Mpdreamz b632051
Update docs/data/release-notes/_snippets/changelog-fields.md
Mpdreamz 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
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
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,74 @@ | ||
| ## Description | ||
|
|
||
| Create a changelog note file for an item that applies to one or more specific release versions and has no associated pull request. | ||
|
Mpdreamz marked this conversation as resolved.
|
||
| Notes are used for known issues, security advisories, and other items that are not tied to a single PR. | ||
| For details and examples, go to [](/data/release-notes/create.md). | ||
|
|
||
| Note files are named `note-{slug}.yml` and are uploaded to the changelog pool like any other entry. | ||
| Each note declares `products[].versions` — the release versions it applies to — instead of deriving its release line from a branch. | ||
|
|
||
| ## Options | ||
|
|
||
| : `--products` | ||
| Products and versions in the format `"product versions lifecycle, ..."` where `versions` is a `|`-separated list of release versions (for example, `"elasticsearch 9.3.0|9.4.0 ga"`). | ||
| Unlike `changelog add`, the middle slot is interpreted as a `|`-separated version list, not a single target. | ||
| The valid product identifiers are listed in [products.yml](https://github.com/elastic/docs-builder/blob/main/config/products.yml). | ||
|
|
||
| : `--title` | ||
| A short, user-facing headline for the note (max 80 characters). Required. | ||
|
|
||
| : `--type` | ||
| The type of change. For valid values, see [ChangelogEntryType.cs](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation/ChangelogEntryType.cs). Required. | ||
|
|
||
| : `--description` | ||
| Additional information about the note (max 600 characters). Optional. | ||
|
|
||
| : `--issues` | ||
| URLs of related issues. Optional citation field; does not determine note addressability. | ||
|
|
||
| ## Product and version format | ||
|
|
||
| The `--products` option uses the same positional format as `changelog add`, but the middle slot is a version list: | ||
|
|
||
| - `"elasticsearch 9.3.0 ga"` — one version | ||
| - `"elasticsearch 9.3.0|9.4.0|9.5.0 ga"` — multiple versions | ||
| - `"cloud-serverless 2025-08-05"` — date-based release, one version | ||
|
|
||
| A note that spans products can declare each product separately: | ||
|
|
||
| ```sh | ||
| docs-builder changelog note \ | ||
| --title "Known issue with aggregations" \ | ||
| --type known-issue \ | ||
| --products "elasticsearch 9.3.0|9.4.0 ga" \ | ||
| --products "kibana 9.3.0|9.4.0 ga" | ||
| ``` | ||
|
|
||
| ## Output | ||
|
|
||
| The command writes a `note-{slug}.yml` file to the configured output directory. | ||
| The file contains `products[].versions` instead of `products[].target`: | ||
|
|
||
| ```yaml | ||
| title: Known issue with aggregations | ||
| type: known-issue | ||
| products: | ||
| - product: elasticsearch | ||
| versions: [9.3.0, 9.4.0] | ||
| lifecycle: ga | ||
| ``` | ||
|
|
||
| ## Lifecycle after creation | ||
|
|
||
| Notes are uploaded to `changelog/{org}/{repo}/{branch}/note-*.yml` in the private S3 bucket and go through the scrubber exactly like entries. | ||
| A Lambda-maintained index at `changelog/{org}/{repo}/notes-{version}.json` lists every note that applies to a given version. | ||
|
|
||
| If the release bundle for that version has already shipped when a note is uploaded, the scrubber Lambda automatically generates an amend sidecar (`{bundle}.amend-notes.yaml`) so the note reaches CDN consumers without a manual rerun. | ||
|
|
||
| ## Configuration checks | ||
|
|
||
| The same configuration-file checks that apply to `changelog add` apply here: | ||
| valid `products`, `lifecycles`, and `type` values are validated against `docs/changelog.yml` when it exists. | ||
|
|
||
| Specifying a version target in `--products` for `changelog add` is an error; use `changelog note` instead. | ||
| Conversely, `--versions` has no meaning for `changelog add` — it is note-specific. | ||
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
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
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
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
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
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
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
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
Oops, something went wrong.
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.