Skip to content

ci: enforce changelog#2764

Merged
miparnisari merged 1 commit intomainfrom
ci-release
Feb 25, 2026
Merged

ci: enforce changelog#2764
miparnisari merged 1 commit intomainfrom
ci-release

Conversation

@miparnisari
Copy link
Contributor

@miparnisari miparnisari commented Dec 12, 2025

Description

This PR introduces a change in the release process.

Problems:

  • make the release notes easier to write
  • we don't have a useful changelog

Assumptions

  1. the most important audience for the release notes should be (a) the users of SpiceDB and (b) SpiceDB's Product Managers (who write https://authzed.com/changelog). (*)
  2. we want to follow https://keepachangelog.com/en/1.1.0/. which states
    • A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project.
    • Using commit log diffs as changelogs is a bad idea: they're full of noise

(*) this does not mean that there aren't other audiences. There are: SpiceDB developers. But, they can rely on commit history.

Proposal

Before Now
On every relase,
the release maker goes through the list of commits,
picking what is important and writing summaries
of each change (perhaps requesting help from PR authors to write said summaries). The release maker has liberty of including whatever they like.
On every PR,
the PR author MAY add an entry in the CHANGELOG.md.
The maintainers review it and request amendments or approve it.
The PR author MAY decide not to include the change in CHANGELOG via a label skip-changelog, but generally every commit with prefixes fix, feat, perf should be included.
On every release, the release maker copies the changelog entries for this release
and pastes them in the release notes.

Testing

$ npx keep-a-changelog
Updated file /Users/miparnisari/Documents/GitHub/spicedb/CHANGELOG.md

@miparnisari miparnisari changed the title ci: do not override existing release notes when publishing ci: enforce changelog Dec 12, 2025
@github-actions github-actions bot added the area/tooling Affects the dev or user toolchain (e.g. tests, ci, build tools) label Dec 12, 2025
@miparnisari miparnisari force-pushed the ci-release branch 6 times, most recently from 9a7a5a2 to 341223f Compare February 19, 2026 21:10
@miparnisari miparnisari marked this pull request as ready for review February 19, 2026 21:11
@miparnisari miparnisari requested a review from a team as a code owner February 19, 2026 21:11
@miparnisari miparnisari marked this pull request as draft February 20, 2026 17:56
@miparnisari miparnisari force-pushed the ci-release branch 2 times, most recently from 1d43d92 to 4979613 Compare February 24, 2026 18:19
tstirrat15
tstirrat15 previously approved these changes Feb 24, 2026
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

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

LGTM

draft: false
prerelease: "auto"
mode: "replace"
mode: "append"
Copy link
Contributor

Choose a reason for hiding this comment

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

Still curious to see what this looks like in practice - I'm a little worried that it's effectively going to duplicate the release content - but I'm okay with learning that when we do the next release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

tstirrat15
tstirrat15 previously approved these changes Feb 25, 2026
Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

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

LGGTM

Copy link
Contributor

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

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

LGTM

@miparnisari miparnisari merged commit 2c39478 into main Feb 25, 2026
44 checks passed
@miparnisari miparnisari deleted the ci-release branch February 25, 2026 14:07
@github-actions github-actions bot locked and limited conversation to collaborators Feb 25, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area/tooling Affects the dev or user toolchain (e.g. tests, ci, build tools)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants