Skip to content

Commit fca7c8b

Browse files
SylvainJugev1v
SylvainJuge
and
v1v
authored
[ci] changelog automation on PRs (#1032)
* add init changelog config + past release bundles * add changelog workflows * handle review * remove changelog/readme file * Apply suggestions from code review Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com> --------- Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>
1 parent 825fb19 commit fca7c8b

16 files changed

Lines changed: 576 additions & 0 deletions

‎.github/workflows/changelog-submit.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: changelog-submit
2+
3+
on:
4+
workflow_run:
5+
workflows: [changelog-validate]
6+
types:
7+
- completed
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
submit:
14+
permissions:
15+
contents: write
16+
pull-requests: write
17+
uses: elastic/docs-actions/.github/workflows/changelog-submit.yml@v1

‎.github/workflows/changelog-validate.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: changelog-validate
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- synchronize
8+
- reopened
9+
- edited
10+
- labeled
11+
- unlabeled
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
validate:
18+
uses: elastic/docs-actions/.github/workflows/changelog-validate.yml@v1

‎docs/changelog.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# use PR ID as changelog to get an immutable filename per PR.
2+
filename: pr
3+
4+
products:
5+
default:
6+
- product: edot-java
7+
lifecycle: ga
8+
9+
# extract context from PR (title, description, linked issues, ...)
10+
extract:
11+
# there are no 'release notes' section in PR descriptions, so we can skip it
12+
release_notes: false
13+
# extract linked issues from PR descriptions
14+
issues: true
15+
16+
# mapping from PR labels to changelog type
17+
pivot:
18+
types:
19+
breaking-change: "breaking-change"
20+
bug-fix: "bug"
21+
deprecation: "deprecation"
22+
feature: "feature"
23+
enhancement: "enhancement, changelog:upstream-update"
24+
docs: "docs, documentation"
25+
# those types should be used after the release is published, they allow to amend existing bundles
26+
# TODO: investigate what is the expected workflow for those and how to amend existing bundles
27+
known-issue:
28+
regression:
29+
security:
30+
31+
rules:
32+
create:
33+
exclude: "changelog:skip"
34+
35+
bundle:
36+
directory: docs/changelog
37+
output_directory: docs/releases
38+
resolve: true
39+
repo: elastic-otel-java
40+
owner: elastic
41+
42+
profiles:
43+
edot-java-release:
44+
products: "edot-java {version} {lifecycle}"
45+
output: "{version}.yaml"

‎docs/releases/1.0.0.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
products:
2+
- product: edot-java
3+
target: 1.0.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 1774534599-first-ga-release.yaml
10+
checksum: 302ab54915fc331db323023dea3d8d2ed3fb3917
11+
type: enhancement
12+
title: first GA release
13+
products:
14+
- product: edot-java
15+
target: 1.0.0
16+
lifecycle: ga

‎docs/releases/1.1.0.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
products:
2+
- product: edot-java
3+
target: 1.1.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 455.yaml
10+
checksum: 2ed25ec4208bd4f01090072823c3c03735deb43f
11+
type: enhancement
12+
title: update upstream 2.10.0
13+
products:
14+
- product: edot-java
15+
target: 1.1.0
16+
lifecycle: ga
17+
prs:
18+
- https://github.com/elastic/elastic-otel-java/pull/455
19+
- file:
20+
name: 423.yaml
21+
checksum: 568cf15908db42bab8cbd9f7f0f8f0bfe773c9d6
22+
type: bug-fix
23+
title: Fix missing transitive dependencies when using universal profiling integration
24+
products:
25+
- product: edot-java
26+
target: 1.1.0
27+
lifecycle: ga
28+
prs:
29+
- https://github.com/elastic/elastic-otel-java/pull/423

‎docs/releases/1.10.0.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
products:
2+
- product: edot-java
3+
target: 1.10.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: upstream-update.yaml
10+
checksum: d71dbd28df5b9fad9ad8ab6a703070092ac76172
11+
type: enhancement
12+
title: Update upstream OpenTelemetry agent dependencies to 2.26.1
13+
products:
14+
- product: edot-java
15+
target: 1.10.0
16+
lifecycle: ga
17+
description: '- javaagent:[2.26.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.26.1) sdk:[1.60.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.60.1) semconv:[1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) contrib:[1.54.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.54.0)'
18+
prs:
19+
- https://github.com/elastic/elastic-otel-java/pull/1017

‎docs/releases/1.2.0.yaml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
products:
2+
- product: edot-java
3+
target: 1.2.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 497.yaml
10+
checksum: e3dbd57033df12ab7d302a2245bb5077481060e7
11+
type: enhancement
12+
title: Add experimental instrumentation for OpenAI client
13+
products:
14+
- product: edot-java
15+
target: 1.2.0
16+
lifecycle: ga
17+
prs:
18+
- https://github.com/elastic/elastic-otel-java/pull/497
19+
- file:
20+
name: 474.yaml
21+
checksum: 135abef4bc8216eaea11bc736b663eb4735f0119
22+
type: enhancement
23+
title: add stop-sending option
24+
products:
25+
- product: edot-java
26+
target: 1.2.0
27+
lifecycle: ga
28+
prs:
29+
- https://github.com/elastic/elastic-otel-java/pull/474
30+
- file:
31+
name: 471.yaml
32+
checksum: ec607a2eaa35edc69d079f5382f8537a88fa8366
33+
type: enhancement
34+
title: add disable all instrumentations option
35+
products:
36+
- product: edot-java
37+
target: 1.2.0
38+
lifecycle: ga
39+
prs:
40+
- https://github.com/elastic/elastic-otel-java/pull/471
41+
- file:
42+
name: 422.yaml
43+
checksum: d981e4a6d649d31a15d89687bcd95bc9babff8f3
44+
type: enhancement
45+
title: add dynamically disabled instrumentation capability
46+
products:
47+
- product: edot-java
48+
target: 1.2.0
49+
lifecycle: ga
50+
prs:
51+
- https://github.com/elastic/elastic-otel-java/pull/422
52+
- file:
53+
name: upstream-update.yaml
54+
checksum: 0f454f651c96799004071cfbe6e10715f178a4d5
55+
type: enhancement
56+
title: Update upstream OpenTelemetry agent dependencies to 2.12.0
57+
products:
58+
- product: edot-java
59+
target: 1.2.0
60+
lifecycle: ga
61+
description: '- javaagent:[2.12.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.12.0) sdk:[1.46.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.46.0) semconv:[1.29.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.29.0) contrib:[1.42.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.42.0)'
62+
prs:
63+
- https://github.com/elastic/elastic-otel-java/pull/500

‎docs/releases/1.2.1.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
products:
2+
- product: edot-java
3+
target: 1.2.1
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 514.yaml
10+
checksum: bacac3ea32027b613bdede584106bbc476052826
11+
type: enhancement
12+
title: Add support for OpenAI client 0.13.0
13+
products:
14+
- product: edot-java
15+
target: 1.2.1
16+
lifecycle: ga
17+
prs:
18+
- https://github.com/elastic/elastic-otel-java/pull/514

‎docs/releases/1.3.0.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
products:
2+
- product: edot-java
3+
target: 1.3.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 564.yaml
10+
checksum: d227a4491edbe1fbb82c718d9d7b9caeefde4c66
11+
type: enhancement
12+
title: Add support for OpenAI client 0.22 to 0.31
13+
products:
14+
- product: edot-java
15+
target: 1.3.0
16+
lifecycle: ga
17+
prs:
18+
- https://github.com/elastic/elastic-otel-java/pull/564
19+
- file:
20+
name: 561.yaml
21+
checksum: ef38522ab77256d90f874ffa57e1b2a6d8eab869
22+
type: enhancement
23+
title: fix upstream otel update for 2.13.3
24+
products:
25+
- product: edot-java
26+
target: 1.3.0
27+
lifecycle: ga
28+
prs:
29+
- https://github.com/elastic/elastic-otel-java/pull/561
30+
- file:
31+
name: 539.yaml
32+
checksum: 948354d7c40f7acffed3ac21bd72e2f6591a7c62
33+
type: enhancement
34+
title: Fix support for OpenAI developer messages
35+
products:
36+
- product: edot-java
37+
target: 1.3.0
38+
lifecycle: ga
39+
prs:
40+
- https://github.com/elastic/elastic-otel-java/pull/539
41+
issues:
42+
- https://github.com/elastic/elastic-otel-java/issues/532
43+
- file:
44+
name: 531.yaml
45+
checksum: 5534514eb260aa6ccfea87e8fd078e035462dfe3
46+
type: enhancement
47+
title: Fix instrumentation support for OpenAI client 0.14+
48+
products:
49+
- product: edot-java
50+
target: 1.3.0
51+
lifecycle: ga
52+
prs:
53+
- https://github.com/elastic/elastic-otel-java/pull/531

‎docs/releases/1.4.0.yaml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
products:
2+
- product: edot-java
3+
target: 1.4.0
4+
lifecycle: ga
5+
repo: elastic-otel-java
6+
owner: elastic
7+
entries:
8+
- file:
9+
name: 583.yaml
10+
checksum: 020bf6ab1dfc9fa1c5335ac62017ca4e943002a0
11+
type: enhancement
12+
title: Change default metric temporality to delta
13+
products:
14+
- product: edot-java
15+
target: 1.4.0
16+
lifecycle: ga
17+
prs:
18+
- https://github.com/elastic/elastic-otel-java/pull/583
19+
issues:
20+
- https://github.com/elastic/elastic-otel-java/issues/446
21+
- file:
22+
name: 607.yaml
23+
checksum: 661657aa8b13d5fd34f9f50739b7a02c544e0dd0
24+
type: enhancement
25+
title: Add support for openAI client 1.1+, drop support for older versions
26+
products:
27+
- product: edot-java
28+
target: 1.4.0
29+
lifecycle: ga
30+
prs:
31+
- https://github.com/elastic/elastic-otel-java/pull/607
32+
- file:
33+
name: 593.yaml
34+
checksum: f187d99aad78afa7200e57099ee3f68864062a9d
35+
type: enhancement
36+
title: Override user agent header for otlp exporters
37+
products:
38+
- product: edot-java
39+
target: 1.4.0
40+
lifecycle: ga
41+
prs:
42+
- https://github.com/elastic/elastic-otel-java/pull/593
43+
issues:
44+
- https://github.com/elastic/elastic-otel-java/issues/448
45+
- file:
46+
name: 596.yaml
47+
checksum: 9872b81d2689ff00a365b7fba66f3b5bfc9b4bc5
48+
type: enhancement
49+
title: enable azure provider by default when available
50+
products:
51+
- product: edot-java
52+
target: 1.4.0
53+
lifecycle: ga
54+
prs:
55+
- https://github.com/elastic/elastic-otel-java/pull/596
56+
- file:
57+
name: upstream-update.yaml
58+
checksum: 2a1a157849699e9ae5cf8c90a0bd24b932664b36
59+
type: enhancement
60+
title: Update upstream OpenTelemetry agent dependencies to 2.15.0
61+
products:
62+
- product: edot-java
63+
target: 1.4.0
64+
lifecycle: ga
65+
description: '- javaagent:[2.15.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.15.0) sdk:[1.49.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.49.0) semconv:[1.32.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.32.0) contrib:[1.45.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.45.0)'
66+
prs:
67+
- https://github.com/elastic/elastic-otel-java/pull/603

0 commit comments

Comments
 (0)