Skip to content

release-step-3: output docs release-notes URL instead of rendered changelog text#1160

Merged
SylvainJuge merged 3 commits into
mainfrom
copilot/replace-gh-release-notes
Jun 30, 2026
Merged

release-step-3: output docs release-notes URL instead of rendered changelog text#1160
SylvainJuge merged 3 commits into
mainfrom
copilot/replace-gh-release-notes

Conversation

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

This updates the release workflow to stop generating GitHub release notes from rendered changelog markdown and instead publish a direct link to Elastic docs for the released version. It removes the temporary docs-builder/sed workaround and aligns release-note content with the canonical docs page.

  • What changed

    • Reworked generate-release-notesPrint Release Notes in .github/workflows/release-step-3.yml.
    • Replaced inline changelog rendering + post-processing with a single versioned docs URL written to GITHUB_OUTPUT.
    • Simplified the release-only generate-release-notes job by removing setup steps that are no longer needed after switching to a direct URL payload.
  • Removed workflow logic

    • docs-builder changelog render invocation.
    • Temporary directory creation for rendered output.
    • Both sed cleanup steps that stripped heading artifacts.
    • Obsolete workaround comment tied to docs-builder behavior.
    • Unused Setup Gradle step.
    • Unused Docs builder setup step.
  • Resulting release-notes payload

    • GitHub release body now resolves to the docs anchor for the released version.
- name: Print Release Notes
  id: print_release_notes
  run: |
    echo 'notes<<RELNOTESEOF' >> $GITHUB_OUTPUT
    echo "https://www.elastic.co/docs/release-notes/edot/sdks/java#${{ env.RELEASE_VERSION }}" >> $GITHUB_OUTPUT
    echo 'RELNOTESEOF' >> $GITHUB_OUTPUT

@SylvainJuge

Copy link
Copy Markdown
Member

@copilot this part of the workflow is only executed at release time, it will not be triggered through regular CI build.

Copilot AI changed the title [WIP] Update release notes to link directly to documentation release-step-3: output docs release-notes URL instead of rendered changelog text Jun 30, 2026
Copilot AI requested a review from SylvainJuge June 30, 2026 07:56
@SylvainJuge SylvainJuge marked this pull request as ready for review June 30, 2026 07:57
@SylvainJuge SylvainJuge requested review from a team as code owners June 30, 2026 07:57

Copilot AI commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

@copilot this part of the workflow is only executed at release time, it will not be triggered through regular CI build.

Updated in 06d1245. I removed the now-unused Setup Gradle and Docs builder setup steps from generate-release-notes so this release-only path stays minimal and avoids unnecessary release-time dependencies.

@fr4nc1sc0-r4m0n fr4nc1sc0-r4m0n left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@SylvainJuge SylvainJuge merged commit 70d58b8 into main Jun 30, 2026
25 of 27 checks passed
@SylvainJuge SylvainJuge deleted the copilot/replace-gh-release-notes branch June 30, 2026 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants