[ci] another changelog release fix#1075
Conversation
SylvainJuge
commented
Apr 27, 2026
SylvainJuge
commented
- make changelog bundle on 'pre' release step
- fix generated changelog
- fix changelog remove command with missing version
- make release process depend on release notes
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
| - name: Generate documentation changelog bundle (post release) | ||
| if: inputs.phase == 'post' | ||
| - name: Generate documentation changelog bundle (pre release) | ||
| if: inputs.phase == 'pre' |
There was a problem hiding this comment.
[for reviewer] changelog bundle generation should happen in the "pre" step so we can review the generated changelog bundle when the first release PR is created.
| --output docs/releases/${{ env.RELEASE_VERSION }}.yaml \ | ||
| --description "${description}" | ||
| docs-builder changelog remove edot-java-release | ||
| docs-builder changelog remove edot-java-release ${{ env.RELEASE_VERSION }} |
There was a problem hiding this comment.
adds missing argument, otherwise the remove command fails.
| if: ${{ ! inputs.skip_maven_deploy }} | ||
| needs: | ||
| - validate-tag | ||
| - generate-release-notes |
There was a problem hiding this comment.
not strictly required, but makes the release-notes generation be a mandatory step early in the process, if anything fails (fast), then we don't even start the release binary generation and publication which is easier to deal with in case of issue.
There was a problem hiding this comment.
this file has been removed by the bundle remove command applied manually for the 1.11.0 release.
| @@ -0,0 +1,27 @@ | |||
| products: | |||
There was a problem hiding this comment.
resulting changelog bundle that should have been produced if the task had been run in the pre release step, it has been generated by manually calling the following equivalent shell script:
#!/bin/bash
version=1.11.0
description="$(.ci/changelog-bundle-description.sh)"
docs-builder changelog bundle \
--input-products 'edot-java * *' \
--output-products "edot-java ${version} ga" \
--output docs/releases/${version}.yaml \
--description "${description}"
docs-builder changelog remove edot-java-release ${version}
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the release automation to generate and consume documentation changelog bundles earlier in the release process, and cleans up generated changelog artifacts accordingly.
Changes:
- Move docs changelog bundle generation to the pre-release phase and fix the
docs-builder changelog removeinvocation to include the version. - Ensure the main release workflow waits for release notes generation before running the release job.
- Update release documentation artifacts by adding the
1.11.0release bundle and removing the now-bundledupstream-updatechangelog entry file.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/releases/1.11.0.yaml | Adds the generated release bundle for 1.11.0 (needs formatting/consistency fixes noted in comments). |
| docs/changelog/upstream-update.yaml | Removes the bundled changelog entry file from docs/changelog. |
| .github/workflows/release-step-3.yml | Makes the release job depend on generate-release-notes. |
| .github/workflows/pre-post-release.yml | Runs changelog bundling during pre-release and fixes the remove command to include the version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,27 @@ | |||
| products: | |||
There was a problem hiding this comment.
The file starts with a UTF-8 BOM character before products: (visible as �/). This can break some YAML tooling and also differs from most existing release bundles; please remove the BOM so the first key is plain products:.
| products: | |
| products: |
There was a problem hiding this comment.
opened elastic/docs-builder#3191 to improve/clarify this.
| lifecycle: ga | ||
| repo: elastic-otel-java | ||
| owner: elastic | ||
| description: >- |
There was a problem hiding this comment.
description is using a folded block scalar (>-). All other release bundles use a literal scalar (|-), which preserves markdown newlines exactly; folded scalars can subtly change formatting (e.g., list rendering) when the docs are generated. Please switch this to |- for consistency and predictable output.
| description: >- | |
| description: |- |
| * semantic-conventions-java: [1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) | ||
|
|
||
| * opentelemetry-java-contrib: [1.55.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.55.0) | ||
| release-date: 2026-04-27 |
There was a problem hiding this comment.
release-date is unquoted here. In YAML this will be parsed as a timestamp/date type, while other release bundles quote the date to keep it a plain string. Please quote it (e.g., 'YYYY-MM-DD') to match existing bundles and avoid type-dependent behavior in downstream tooling.
| release-date: 2026-04-27 | |
| release-date: '2026-04-27' |
