|
| 1 | +# REQUIRED |
| 2 | +# Kind can be one of: |
| 3 | +# - breaking-change: a change to previously-documented behavior |
| 4 | +# - deprecation: functionality that is being removed in a later release |
| 5 | +# - bug-fix: fixes a problem in a previous version |
| 6 | +# - enhancement: extends functionality but does not break or fix existing behavior |
| 7 | +# - feature: new functionality |
| 8 | +# - known-issue: problems that we are aware of in a given version |
| 9 | +# - security: impacts on the security of a product or a user’s deployment. |
| 10 | +# - upgrade: important information for someone upgrading from a prior version |
| 11 | +# - other: does not fit into any of the other categories |
| 12 | +kind: enhancement |
| 13 | + |
| 14 | +# REQUIRED for all kinds |
| 15 | +# Change summary; a 80ish characters long description of the change. |
| 16 | +summary: Add logic that will add `include`s to `_snippets` files in the correct order if the `rendered_changelog_destination` in the `config.changelog.yaml` is using `release-notes/_snippets`. |
| 17 | + |
| 18 | +# REQUIRED for breaking-change, deprecation, known-issue |
| 19 | +# Long description; in case the summary is not enough to describe the change |
| 20 | +# this field accommodate a description without length limits. |
| 21 | +description: When using the `release-notes/_snippets` model, there are multiple levels of nesting to make it as easy as possible to insert new patch version sections in the correct order. The updates in this PR will (1) eliminate any manual steps in the resulting release notes PR outside of copy edits, and (2) reduce the chance of conflicts when forward porting to later minors and `main`. |
| 22 | + |
| 23 | +# REQUIRED for breaking-change, deprecation, known-issue |
| 24 | +# impact: |
| 25 | + |
| 26 | +# REQUIRED for breaking-change, deprecation, known-issue |
| 27 | +# action: |
| 28 | + |
| 29 | +# REQUIRED for all kinds |
| 30 | +# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc. |
| 31 | +component: |
| 32 | + |
| 33 | +# AUTOMATED |
| 34 | +# OPTIONAL to manually add other PR URLs |
| 35 | +# PR URL: A link the PR that added the changeset. |
| 36 | +# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added. |
| 37 | +# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number. |
| 38 | +# Please provide it if you are adding a fragment for a different PR. |
| 39 | +pr: |
| 40 | + - https://github.com/elastic/elastic-agent-changelog-tool/pull/220 |
| 41 | + |
| 42 | +# AUTOMATED |
| 43 | +# OPTIONAL to manually add other issue URLs |
| 44 | +# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of). |
| 45 | +# If not present is automatically filled by the tooling with the issue linked to the PR number. |
| 46 | +# issue: https://github.com/owner/repo/1234 |
0 commit comments