Skip to content

Commit c031be5

Browse files
authored
Generate the consolidated 8.5.0 changelog. (#1642) (#1670)
* Consolidate the 8.5.0 changelog fragments. Generate a summarized YAML file of all the changes in 8.5.0 for future reference. The rendered changelog lives in the observability-docs repository currently. * Improve README documentation for the changelog.
1 parent 188688f commit c031be5

13 files changed

+147
-93
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,30 @@
55
The source files for the general Elastic Agent documentation are currently stored
66
in the [observability-docs](https://github.com/elastic/observability-docs) repo. The following docs are only focused on getting developers started building code for Elastic Agent.
77

8+
### Changelog
9+
10+
The changelog for the Elastic Agent is generated and maintained using the [elastic-agent-changelog-tool](https://github.com/elastic/elastic-agent-changelog-tool). Read the [installation](https://github.com/elastic/elastic-agent-changelog-tool/blob/main/docs/install.md)
11+
and [usage](https://github.com/elastic/elastic-agent-changelog-tool/blob/main/docs/usage.md#im-a-developer) instructions to get started.
12+
13+
The changelog tool produces fragement files that are consolidated to generate a changelog for each release. Each PR containing a change with user
14+
impact (new feature, bug fix, etc.) must contain a changelog fragement describing the change. There is a GitHub action in CI that will fail
15+
if a PR does not contain a changelog fragment. For PRs that should not have a changelog entry, use the "skip-changelog" label to bypass
16+
this check.
17+
18+
A simple example of a changelog fragment is below for reference:
19+
20+
```yml
21+
kind: bug-fix
22+
summary: Fix a panic caused by a race condition when installing the Elastic Agent.
23+
pr: https://github.com/elastic/elastic-agent/pull/823
24+
```
25+
826
## Testing
927
1028
Prerequisites:
1129
- installed [mage](https://github.com/magefile/mage)
1230
- [Docker](https://docs.docker.com/get-docker/)
1331
- [X-pack](https://github.com/elastic/beats/tree/main/x-pack) to pre-exist in the parent folder of the local Git repository checkout
14-
- [elastic-agent-changelog-tool](https://github.com/elastic/elastic-agent-changelog-tool) to add changelog fragments for changelog generation
1532
1633
If you are on a Mac with M1 chip, don't forget to export some docker variable to be able to build for AMD
1734
```

changelog/8.5.0.yaml

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
version: 8.5.0
2+
entries:
3+
- kind: bug-fix
4+
summary: Fix a panic caused by a race condition when installing the Elastic Agent.
5+
description: ""
6+
component: ""
7+
pr:
8+
- https://github.com/elastic/elastic-agent/pull/823
9+
issue:
10+
- https://github.com/elastic/elastic-agent/issues/806
11+
timestamp: 1660139385
12+
file:
13+
name: 1660139385-Fix-a-panic-caused-by-a-race-condition-when-installing-the-Elastic-Agent.yaml
14+
checksum: be820e85b12290a895bfd37c2c2245bfae5a70c9
15+
- kind: breaking-change
16+
summary: Upgrade to Go 1.18. Certificates signed with SHA-1 are now rejected. See the Go 1.18 https//tip.golang.org/doc/go1.18#sha1[release notes] for details.
17+
description: ""
18+
component: ""
19+
pr:
20+
- https://github.com/elastic/elastic-agent/pull/832
21+
issue: []
22+
timestamp: 1660158319
23+
file:
24+
name: 1660158319-Upgrade-to-Go-118-Certificates-signed-with-SHA-1-are-now-rejected-See-the-Go-118.yaml
25+
checksum: 2b304d75a687ec7384f3011a55f243fef66e447b
26+
- kind: feature
27+
summary: Add `lumberjack` input type to the Filebeat spec.
28+
description: ""
29+
component: ""
30+
pr:
31+
- https://github.com/elastic/elastic-agent/pull/959
32+
issue: []
33+
timestamp: 1661188787
34+
file:
35+
name: 1661188787-Add-lumberjack-input-type-to-the-Filebeat-spec.yaml
36+
checksum: ab7e3af045affbda1522c029cc56a9c5403340c3
37+
- kind: feature
38+
summary: Add support for hints' based autodiscovery in kubernetes provider.
39+
description: ""
40+
component: ""
41+
pr:
42+
- https://github.com/elastic/elastic-agent/pull/698
43+
issue: []
44+
timestamp: 1663143487
45+
file:
46+
name: 1663143487-Add-support-for-hints-based-autodiscovery-in-kubernetes-provider.yaml
47+
checksum: 398470d14a8475e93aaf66f96407570653dde71e
48+
- kind: bug-fix
49+
summary: Fix unintended reset of source URI when downloading components
50+
description: ""
51+
component: ""
52+
pr:
53+
- https://github.com/elastic/elastic-agent/pull/1252
54+
issue: []
55+
timestamp: 1664177394
56+
file:
57+
name: 1664177394-Fix-unintended-reset-of-source-URI-when-downloading-components.yaml
58+
checksum: 1040aceb00b70182c0bba621e15cfe711e32f9fe
59+
- kind: bug-fix
60+
summary: Create separate status reporter for local only events so that degraded fleet-checkins no longer affect health on successful fleet-checkins.
61+
description: ""
62+
component: ""
63+
pr:
64+
- https://github.com/elastic/elastic-agent/pull/1285
65+
issue:
66+
- https://github.com/elastic/elastic-agent/issues/1157
67+
timestamp: 1664212969
68+
file:
69+
name: 1664212969-Create-separate-status-reporter-for-local-only-events-so-that-degraded-fleet-che.yaml
70+
checksum: 929f1ada47aeaaf9c631091c0f2732f631b3539f
71+
- kind: feature
72+
summary: Improve logging during upgrades.
73+
description: ""
74+
component: ""
75+
pr:
76+
- https://github.com/elastic/elastic-agent/pull/1287
77+
issue:
78+
- https://github.com/elastic/elastic-agent/issues/1253
79+
timestamp: 1664230732
80+
file:
81+
name: 1664230732-Improve-logging-during-upgrades.yaml
82+
checksum: 13ab968324d342118c5a257d6c6cc0c5db161b46
83+
- kind: bug-fix
84+
summary: Add success log message after previous checkin failures
85+
description: ""
86+
component: ""
87+
pr:
88+
- https://github.com/elastic/elastic-agent/pull/1327
89+
issue: []
90+
timestamp: 1664360554
91+
file:
92+
name: 1664360554-Add-success-log-message-after-previous-checkin-failures.yaml
93+
checksum: 819a22a452dddfa3b2976433d5cb4c8354a6ccc5
94+
- kind: bug-fix
95+
summary: Fix docker provider add_fields processors
96+
description: ""
97+
component: providers
98+
pr:
99+
- https://github.com/elastic/elastic-agent/pull/1420
100+
issue:
101+
- https://github.com/elastic/elastic-agent/issues/29030
102+
timestamp: 1664989867
103+
file:
104+
name: 1664989867-fix-docker-provider-processors.yaml
105+
checksum: 45731791cd2e8f1d747abfc47bb256971a77d015
106+
- kind: enhancement
107+
summary: Improve logging of Fleet check-in errors.
108+
description: Improve logging of Fleet check-in errors and only report the local state as degraded after two consecutive failed check-ins.
109+
component: ""
110+
pr:
111+
- https://github.com/elastic/elastic-agent/pull/1477
112+
issue:
113+
- https://github.com/elastic/elastic-agent/issues/1154
114+
timestamp: 1665517984
115+
file:
116+
name: 1665517984-improve-checkin-error-logging.yaml
117+
checksum: 2d3dd39309def9a082f794eda815af459596c2e6
118+
- kind: bug-fix
119+
summary: Fix admin permission check on localized windows
120+
description: ""
121+
component: ""
122+
pr:
123+
- https://github.com/elastic/elastic-agent/pull/1552
124+
issue:
125+
- https://github.com/elastic/elastic-agent/issues/857
126+
timestamp: 1666088774
127+
file:
128+
name: 1666088774-Fix-admin-permission-check-on-localized-windows.yaml
129+
checksum: 16ee5909c319680b8d32045e74c38922eafc29ea

changelog/fragments/1660139385-Fix-a-panic-caused-by-a-race-condition-when-installing-the-Elastic-Agent.yaml

-3
This file was deleted.

changelog/fragments/1660158319-Upgrade-to-Go-118-Certificates-signed-with-SHA-1-are-now-rejected-See-the-Go-118.yaml

-3
This file was deleted.

changelog/fragments/1661188787-Add-lumberjack-input-type-to-the-Filebeat-spec.yaml

-3
This file was deleted.

changelog/fragments/1663143487-Add-support-for-hints-based-autodiscovery-in-kubernetes-provider.yaml

-3
This file was deleted.

changelog/fragments/1664177394-Fix-unintended-reset-of-source-URI-when-downloading-components.yaml

-3
This file was deleted.

changelog/fragments/1664212969-Create-separate-status-reporter-for-local-only-events-so-that-degraded-fleet-che.yaml

-4
This file was deleted.

changelog/fragments/1664230732-Improve-logging-during-upgrades.yaml

-3
This file was deleted.

changelog/fragments/1664360554-Add-success-log-message-after-previous-checkin-failures.yaml

-3
This file was deleted.

changelog/fragments/1664989867-fix-docker-provider-processors.yaml

-31
This file was deleted.

changelog/fragments/1665517984-improve-checkin-error-logging.yaml

-5
This file was deleted.

changelog/fragments/1666088774-Fix-admin-permission-check-on-localized-windows.yaml

-31
This file was deleted.

0 commit comments

Comments
 (0)