Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release notes #171

Closed
wants to merge 2 commits into from
Closed

Conversation

sleto-it
Copy link

@sleto-it sleto-it commented Sep 18, 2024

This PR adds the release notes in the doc. This will help users better tracking releases and list of changes.
The content is taken from the valkey repo, 00-RELEASENOTES files (for the branches 8.0 and 7.2).

Links to the fixing PRs have been included (when the PR number was mentioned in the 00-RELEASENOTES).
Links to some GitHub Issues have been included as well (when the Issue number was mentioned in the 00-RELEASENOTES).

A ToC was included in the page to help navigation.

Release notes have been linked in the main Docs menu. Related PR in valkey-io.github.io: valkey-io/valkey-io.github.io#140.

Preview below

1  adding_release_notes-toc
2  adding_release_notes-preview
3  adding_release_notes-link-to-prs

Signed-off-by: Santo Leto <[email protected]>
Co-authored-by: Anastasia Alexandrova <[email protected]>
Signed-off-by: Santo <[email protected]>
@zuiderkwast
Copy link
Contributor

This means we'll have to commit release notes to the doc repo every time we do a new release? It adds some extra work to the release process.

I would prefer that the website logic automatically would take the release notes from each release.

@stockholmux WDYT?

@zuiderkwast zuiderkwast added the to-be-closed Not to be merged label Sep 22, 2024
@stockholmux
Copy link
Member

@zuiderkwast Yeah, I'd rather avoid committing the release notes to the docs repo for a variety of reasons.

Release notes are currently linked on every non-rc release from the releases page for each version, but admittedly that isn't quite obvious and misses anything put in RC releases.

GitHub Actions could be used to merge all this stuff together using minimal metadata on the website side (effectively adding a new element to array with each release). The website is quite good at including files inside the template, so we could do something like /release-notes/8.0.0, /release-notes/8.0.0-rc2, /release-notes/8.0.0-rc1 , etc. with a single version's release notes.

This is subtly different from what's being proposed, which is one giant page. (The giant page is also kind of an antipattern anyway).

@zuiderkwast
Copy link
Contributor

@stockholmux I like this suggestion.

@stockholmux
Copy link
Member

@sleto-it would you mind creating an issue on https://github.com/valkey-io/valkey-io.github.io so we can track getting this built? I'm glad to roll it into your PR valkey-io/valkey-io.github.io#140 as well.

@sleto-it
Copy link
Author

sleto-it commented Oct 2, 2024

Hi @stockholmux,
Sure, and thanks. Done: valkey-io/valkey-io.github.io#145

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
to-be-closed Not to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants