Skip to content

update release changelog with docs-builder #1047

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.

Sign up for GitHub

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

Open
SylvainJuge wants to merge 6 commits into
base: main
Choose a base branch
from
Open

update release changelog with docs-builder #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b8d8b9
version and 'ga' not required to add
SylvainJuge Apr 9, 2026
a5d38ff
generate release bundle on release
SylvainJuge Apr 9, 2026
e172367
cleanup
SylvainJuge Apr 9, 2026
941e2f7
remove unused gradle task
SylvainJuge Apr 9, 2026
ac4b775
forgot to add docs-builder to release
SylvainJuge Apr 9, 2026
5faef99
use env variable to generate gh changelog
SylvainJuge Apr 9, 2026
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
295 changes: 0 additions & 295 deletions .ci/ReleaseChangelog.java
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion .ci/changelog-upstream-update.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ docs-builder changelog add \
--title "${PR_TITLE}" \
--type enhancement \
--prs "${PR_URL}" \
--products "edot-java NEXT ga" \
Copy link
Copy Markdown
Member Author

@SylvainJuge SylvainJuge Apr 9, 2026

Choose a reason for hiding this comment

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

setting the {version} as NEXT is not needed, nor is the 3rd element of the product definition, the edot-java-release profile will match all the changelog entries in the docs/changelog/ folder.

--products "edot-java" \
--description "${description}"

# will overwrite any prior update, if there is any
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/pre-post-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ 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 @@ -95,14 +98,11 @@ jobs:
with:
command: ./gradlew -q setNextVersion

- name: Generate documentation changelog (post release)
- name: Generate documentation changelog bundle (post release)
if: inputs.phase == 'post'
run: |
echo '<!--DEPENDENCIES-NOTES-START-->' >> CHANGELOG.next-release.md
echo -e "This release is based on the following upstream versions:\n\n" >> CHANGELOG.next-release.md
./gradlew -q printUpstreamDependenciesMarkdown >> CHANGELOG.next-release.md
echo '<!--DEPENDENCIES-NOTES-END-->' >> CHANGELOG.next-release.md
java .ci/ReleaseChangelog.java CHANGELOG.next-release.md docs/release-notes ${{ env.RELEASE_VERSION }}
docs-builder changelog bundle edot-java-release ${{ env.RELEASE_VERSION }}
docs-builder changelog remove edot-java-release

- name: Push the ${{ inputs.phase }} release branch
run: |
Expand Down
15 changes: 9 additions & 6 deletions .github/workflows/release-step-3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,16 +221,19 @@ jobs:
uses: ./.github/workflows/gradle-goal
with:
command: ""
- name: Docs builder setup
Copy link
Copy Markdown
Contributor

@macroscopeapp macroscopeapp bot Apr 9, 2026

Choose a reason for hiding this comment

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

🔴 Critical workflows/release-step-3.yml:224

The docs-builder changelog render command receives a non-existent path as --input. The ${tmp}/${{ env.RELEASE_VERSION }} directory is freshly created by mktemp -d and empty — no bundle file is copied there before the render command. This causes the command to fail with "Bundle file does not exist", breaking the generate-release-notes job and blocking downstream release steps. Consider copying the bundle YAML file to the temp directory before invoking docs-builder, or pass the correct path to the existing bundle file.

🚀 Reply "fix it for me" or copy this AI Prompt for your agent: 
In file .github/workflows/release-step-3.yml around line 224:

The `docs-builder changelog render` command receives a non-existent path as `--input`. The `${tmp}/${{ env.RELEASE_VERSION }}` directory is freshly created by `mktemp -d` and empty — no bundle file is copied there before the render command. This causes the command to fail with "Bundle file does not exist", breaking the `generate-release-notes` job and blocking downstream release steps. Consider copying the bundle YAML file to the temp directory before invoking `docs-builder`, or pass the correct path to the existing bundle file.

Copy link
Copy Markdown
Member Author

@SylvainJuge SylvainJuge Apr 9, 2026

Choose a reason for hiding this comment

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

this file is created by docs-builder, this is why it does not exist before invocation.

uses: elastic/docs-actions/docs-builder/setup@v1
- name: Print Release Notes
id: print_release_notes
# note: release notes here will be copied as-is from 'CHANGELOG.next-release.md'
# the 'pre-post-release' workflow executed after this will reset contents of 'CHANGELOG.next-release.md'
# FIXME using temporary workaround from https://github.com/elastic/docs-builder/issues/3057
run: |
echo 'notes<<RELNOTESEOF' >> $GITHUB_OUTPUT
cat CHANGELOG.next-release.md >> $GITHUB_OUTPUT
printf '\nThis release is based on the following upstream versions:\n\n' >> $GITHUB_OUTPUT
./gradlew -q printUpstreamDependenciesMarkdown >> $GITHUB_OUTPUT
echo 'RELNOTESEOF' >> $GITHUB_OUTPUT
tmp="$(mktemp -d)"
docs-builder changelog render --input "${tmp}/${{ env.RELEASE_VERSION }}" --output "${tmp}"
cat "${tmp}/${{ env.RELEASE_VERSION }}/index.md" \
| sed -e "/## ${{ env.RELEASE_VERSION }} \[elastic-release-notes-${{ env.RELEASE_VERSION }}/d" \
| sed -e "/###/s/ \[elastic-${{ env.RELEASE_VERSION }}.*$//g" >> $GITHUB_OUTPUT
echo 'RELNOTESEOF' >> $GITHUB_OUTPUT


post-release:
Expand Down
Loading
Loading