-
Notifications
You must be signed in to change notification settings - Fork 48
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
Add release notes #171
Conversation
Signed-off-by: Santo Leto <[email protected]>
f7fa805
to
91bde8e
Compare
Co-authored-by: Anastasia Alexandrova <[email protected]> Signed-off-by: Santo <[email protected]>
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 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 This is subtly different from what's being proposed, which is one giant page. (The giant page is also kind of an antipattern anyway). |
@stockholmux I like this suggestion. |
@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. |
Hi @stockholmux, |
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 branches8.0
and7.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 invalkey-io.github.io
: valkey-io/valkey-io.github.io#140.Preview below