Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .ci/changelog-upstream-update.sh

This file was deleted.

58 changes: 0 additions & 58 deletions .github/workflows/changelog-init.yml

This file was deleted.

18 changes: 0 additions & 18 deletions .github/workflows/changelog-submit.yml

This file was deleted.

15 changes: 0 additions & 15 deletions .github/workflows/changelog-upload.yml

This file was deleted.

17 changes: 0 additions & 17 deletions .github/workflows/pre-post-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ jobs:
with:
github-token: ${{ steps.get_token.outputs.token }}

- name: Docs builder setup
uses: elastic/docs-actions/docs-builder/setup@v1

- name: Create the release tag (post phase)
if: inputs.phase == 'post'
run: |
Expand All @@ -102,20 +99,6 @@ jobs:
if: inputs.phase == 'post'
run: bash ./.ci/release/post-release.sh

- name: Generate documentation changelog bundle (pre release)
if: inputs.phase == 'pre'
# we should use the 'edot-java-release' profile to generate the bundle:
# docs-builder changelog bundle edot-java-release ${{ env.RELEASE_VERSION }}
# this does not yet allow to provide the generated content for description, so we have to use the explicit arguments.
run: |
description="$(.ci/changelog-bundle-description.sh)"
docs-builder changelog bundle \
--input-products 'edot-java * *' \
--output-products 'edot-java ${{ env.RELEASE_VERSION }} ga' \
--output docs/releases/${{ env.RELEASE_VERSION }}.yaml \
--description "${description}"
docs-builder changelog remove edot-java-release ${{ env.RELEASE_VERSION }}

- name: Push the ${{ inputs.phase }} release branch
run: |
git add --all
Expand Down
13 changes: 13 additions & 0 deletions .github/workflows/release-notes-changelog-file.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Changelog file
on:
workflow_run:
# Must match the `name:` field of the release-notes workflow in this repo.
workflows: ["release-notes"]
types: [completed]
permissions: {}
jobs:
changelog-file:
uses: elastic/docs-actions/.github/workflows/release-notes-changelog-file.yml@v1
permissions:
pull-requests: write
actions: read
19 changes: 19 additions & 0 deletions .github/workflows/release-notes-comments.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Changelog PR comments
on:
workflow_run:
# Must match the `name:` field of the release-notes workflow in this repo.
workflows: ["release-notes"]
types: [completed]
permissions: {}
# The PR number is stable; do not cancel — two upstreams can complete close
# together and cancelling mid-upsert risks leaving the wrong comment body.
concurrency:
group: changelog-comments-${{ github.event.workflow_run.head_repository.full_name }}-${{ github.event.workflow_run.head_branch }}
cancel-in-progress: false
jobs:
comment:
if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion != 'cancelled'
uses: elastic/docs-actions/.github/workflows/release-notes-comments.yml@v1
Comment thread
v1v marked this conversation as resolved.
permissions:
pull-requests: write
actions: read
14 changes: 14 additions & 0 deletions .github/workflows/release-notes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: release-notes
on:
pull_request:
types: [opened, synchronize, reopened, edited, labeled, unlabeled]
push:
branches: [main]
permissions: {}
jobs:
release-notes:
permissions:
contents: read
pull-requests: read
packages: read
uses: elastic/docs-actions/.github/workflows/release-notes.yml@v1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it only checking the PR has a changelog file and/or the appropriate labels are applied here ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a PR event it always validates labels, checks whether a changelog file is present (if the labels and workflow config require one), and if a file is present validates its name format and contents. On push to main it uploads the merged PR's changelog entry to the CDN. Bundle creation is separate, handled by bundle-create-version@v1 in release-step-3.yml after the GitHub release is cut.

44 changes: 44 additions & 0 deletions .github/workflows/release-step-3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -262,3 +262,47 @@ jobs:
--verify-tag \
--title="Release ${{ env.RELEASE_VERSION }}" \
--notes='${{needs.generate-release-notes.outputs.notes}}'

bundle:
name: "Generate changelog bundle"
needs: create-github-release
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
pull-requests: read
outputs:
bundle-path: ${{ steps.create.outputs.bundle-path }}
steps:
- uses: actions/checkout@v7
with:
ref: ${{ inputs.ref }}
persist-credentials: false
- name: Generate bundle description
id: description
run: echo "text=$(.ci/changelog-bundle-description.sh)" >> "$GITHUB_OUTPUT"
- name: Create bundle
id: create
uses: elastic/docs-actions/changelog/bundle-create-version@v1
with:
version: ${{ env.RELEASE_VERSION_TAG }}
description: ${{ steps.description.outputs.text }}
github-token: ${{ github.token }}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To implement #1238 would it be just a matter of modifying the bundle file just between those two steps ? Or is it something we would need to do on a separate workflow ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plan is to add a description input to elastic/docs-actions/changelog/bundle-create-version@v1 itself, then wire the output of .ci/changelog-bundle-description.sh into it here in release-step-3.yml. That keeps the description logic in this repo and avoids rebuilding it inside the action. Tracked in #1238.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done — elastic/docs-actions#367 adds a description input to bundle-create-version@v1, and this PR now runs .ci/changelog-bundle-description.sh before Create bundle and passes its output as that input. Ties off the last item from the old pre-release bundle step.


bundle-publish:
name: "Publish changelog bundle to S3"
needs: bundle
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
packages: read
steps:
- uses: actions/checkout@v7
with:
ref: ${{ inputs.ref }}
persist-credentials: false
- name: Publish bundle to S3
uses: elastic/docs-actions/changelog/bundle-publish@v1
with:
bundle-path: ${{ needs.bundle.outputs.bundle-path }}
4 changes: 3 additions & 1 deletion docs/docset.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
project: 'EDOT Java release notes'
cross_links:
- docs-content
Expand All @@ -9,6 +9,8 @@
toc:
- toc: release-notes
- toc: reference/edot-java
release_notes:
- product: edot-java
subs:
motlp: Elastic Cloud Managed OTLP Endpoint
edot: Elastic Distribution of OpenTelemetry
Expand All @@ -23,4 +25,4 @@
stack: "Elastic Stack"
es: "Elasticsearch"
kib: "Kibana"
ls: "Logstash"
ls: "Logstash"
2 changes: 1 addition & 1 deletion docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@

Breaking changes can impact your applications, potentially disrupting normal operations and their monitoring. Before you upgrade, carefully review the Elastic Distribution of OpenTelemetry Java breaking changes and take the necessary steps to mitigate any issues.

:::{changelog} /releases/
:::{changelog} edot-java

Check notice on line 18 in docs/release-notes/breaking-changes.md

View workflow job for this annotation

GitHub Actions / build / build

'edot-java' is registered in products.yml but has no CDN bundles yet. The changelog will render empty until the first release is published.
:type: breaking-change
:::
2 changes: 1 addition & 1 deletion docs/release-notes/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@

Review the deprecated functionality for Elastic Distribution of OpenTelemetry Java. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).

:::{changelog} /releases/
:::{changelog} edot-java

Check notice on line 20 in docs/release-notes/deprecations.md

View workflow job for this annotation

GitHub Actions / build / build

'edot-java' is registered in products.yml but has no CDN bundles yet. The changelog will render empty until the first release is published.
:type: deprecation
:::
2 changes: 1 addition & 1 deletion docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).

:::{changelog} /releases/
:::{changelog} edot-java

Check notice on line 20 in docs/release-notes/index.md

View workflow job for this annotation

GitHub Actions / build / build

'edot-java' is registered in products.yml but has no CDN bundles yet. The changelog will render empty until the first release is published.
:type: all
:release-dates:
:::
2 changes: 1 addition & 1 deletion docs/release-notes/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@

# Elastic Distribution of OpenTelemetry Java known issues

:::{changelog} /releases/
:::{changelog} edot-java

Check notice on line 16 in docs/release-notes/known-issues.md

View workflow job for this annotation

GitHub Actions / build / build

'edot-java' is registered in products.yml but has no CDN bundles yet. The changelog will render empty until the first release is published.
:type: known-issue
:::
Loading