Skip to content

docs: add example release.yml that auto-publishes from CHANGELOG.md#714

Draft
samjewell wants to merge 1 commit into
mainfrom
sj/release-publish-with-changelog-example
Draft

docs: add example release.yml that auto-publishes from CHANGELOG.md#714
samjewell wants to merge 1 commit into
mainfrom
sj/release-publish-with-changelog-example

Conversation

@samjewell
Copy link
Copy Markdown
Contributor

Important

Draft, blocked on #713.

The auto-publish pattern works for any repo using release-please + build-plugin, regardless of whether the underlying `actions/plugins/release-please` action is generic or Grafana-internal-only. But shipping this example next to the existing `release-please.yml` example feels misleading until #713 is resolved one way or the other:

Either way, holding this until that decision is made.

Summary

Companion to `examples/extra/release-please.yml`. Shows how to wire up `build-plugin` alongside an auto-publish step that:

  • Extracts the matching `## [vX.Y.Z]` section from `CHANGELOG.md`
  • Preserves the attestation link `build-plugin` added
  • Publishes the release as `--latest`

This removes the per-release manual "edit draft body, mark latest" step for repos using release-please.

Background

Pattern developed in grafana/grafana-cube-datasource#323 and used to release v0.6.0 of that plugin successfully. Without this step, every release needs a manual edit/publish step.

Test plan

  • Smoke-tested the awk extraction locally against both `## 0.6.0 (date)` (release-please format) and `## 0.5.0 (date)` (older hand-written format) — both extract cleanly.
  • Will be exercised on the next release of grafana-cube-datasource (already merged into that repo's release.yml).

Made with Cursor

Companion to examples/extra/release-please.yml. Shows how to wire up
build-plugin alongside an auto-publish step that restores the matching
CHANGELOG.md section as the release body, preserves the attestation
link, and marks the release as latest.

Removes the per-release manual "edit draft body, mark latest" step for
repos using release-please. Pattern developed in
grafana/grafana-cube-datasource#323.

Co-authored-by: Cursor <cursoragent@cursor.com>
@L2D2Grafana
Copy link
Copy Markdown
Contributor

@samjewell I believe uploading to Github Release is apart of the cd.yml flow. .github/workflows/cd.yml needs to have

 # Publish the github release
 github-draft-release: false

Here is an example in Logs Drilldown https://github.com/grafana/logs-drilldown/pull/1751/changes. The sad thing is that it's failing right now and I eventually had to turn it off because not all zip files were uploaded. Revert PR grafana/logs-drilldown#1785

The 🐛 ticket is here and I believe they are working on it #582

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🔬 In review

Development

Successfully merging this pull request may close these issues.

2 participants