-
Notifications
You must be signed in to change notification settings - Fork 138
Switch to mostly manual release notes #348
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
Conversation
caddc9d
to
dc81512
Compare
9efd326
to
1031753
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
LGTM |
This was hit in CI on one of the Ubuntu / KVM runners but I don't see how it is related to this PR...
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome stuff. LGTM
508ab95
to
033f77e
Compare
Signed-off-by: Ludvig Liljenberg <[email protected]>
Signed-off-by: Ludvig Liljenberg <[email protected]>
Signed-off-by: Ludvig Liljenberg <[email protected]>
033f77e
to
2533c4d
Compare
Closing because unable to merge due to unresolved comments, even though there are no unresolved comments. Reopened as #368 |
Summary
This PR introduces a
CHANGELOG.md
file to the Hyperlight repository to systematically track and document changes. The goal is for this file to be updated with each PR that contributes to the release notes. However, in practice, it will be manually edited by the individual responsible for creating a Hyperlight release.Motivation
The need for manual release notes arose from the limitations of our automatic release notes system. The current automatic notes were generated from PR titles, which often don't adequately reflect the changes in a manner that's easily consumable by users.
Changes
CHANGELOG.md
file has been added to document key changes.CHANGELOG.md
and a full list of PRs with their titles at the end of the release notes.This approach draws inspiration from the release notes format used by Runwasi, as seen in this example.
After this merges, I will replace the old release notes in 0.2.0 with the new ones