update release changelog with docs-builder#1047
Conversation
SylvainJuge
commented
Apr 9, 2026
SylvainJuge
commented
- generates changelog bundle on release
- remove changelog individual entries on release
- cleanup of unused code
📋 Changelog🔖 Add one of these type labels to your PR:
🔖 To skip changelog generation or configure label rules, see |
🔍 Preview links for changed docs |
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
| profiles: | ||
| edot-java-release: | ||
| products: "edot-java {version} {lifecycle}" | ||
| products: "edot-java * *" |
There was a problem hiding this comment.
[for reviewer] this makes the profile match all the changelog entries for edot-java for any version (as the changelog entries themselves do not have a target field set).
| --title "${PR_TITLE}" \ | ||
| --type enhancement \ | ||
| --prs "${PR_URL}" \ | ||
| --products "edot-java NEXT ga" \ |
There was a problem hiding this comment.
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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe change migrates changelog and release-notes generation from a custom Java tool and a Gradle task to an Elastic docs‑builder workflow. It deletes the Java CLI ( ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/release-step-3.yml:
- Around line 228-237: The workflow is rendering a non-existent input and
leaving output redirections unquoted; update the docs-builder invocation to use
the real release YAML path docs-builder changelog render --input
"./docs/releases/${version}.yaml" --output "${tmp}", and quote all
$GITHUB_OUTPUT uses and any redirect expansions (replace >> $GITHUB_OUTPUT with
>> "$GITHUB_OUTPUT" and the initial echo 'notes<<RELNOTESEOF' >> $GITHUB_OUTPUT
with echo 'notes<<RELNOTESEOF' >> "$GITHUB_OUTPUT"), keeping existing
"${tmp}/${version}/index.md" and sed pipelines intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5ff9724e-d970-4d6a-9ef6-045c1acc6b05
📒 Files selected for processing (8)
.ci/ReleaseChangelog.java.ci/changelog-upstream-update.sh.github/workflows/pre-post-release.yml.github/workflows/release-step-3.ymlCHANGELOG.mdCHANGELOG.next-release.mdbuild.gradle.ktsdocs/changelog.yml
💤 Files with no reviewable changes (4)
- CHANGELOG.next-release.md
- CHANGELOG.md
- build.gradle.kts
- .ci/ReleaseChangelog.java
| uses: ./.github/workflows/gradle-goal | ||
| with: | ||
| command: "" | ||
| - name: Docs builder setup |
There was a problem hiding this comment.
🔴 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.
There was a problem hiding this comment.
this file is created by docs-builder, this is why it does not exist before invocation.
1 participant
