Skip to content

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

Closed
wants to merge 3 commits into from

Conversation

ludfjig
Copy link
Contributor

@ludfjig ludfjig commented Mar 11, 2025

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

  • A CHANGELOG.md file has been added to document key changes.
  • The GitHub release notes will now include both the content from the 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

@ludfjig ludfjig force-pushed the fix_release_notes branch from caddc9d to dc81512 Compare March 11, 2025 23:51
@ludfjig ludfjig added the area/infrastructure Concerns infrastructure rather than core functionality label Mar 11, 2025
@ludfjig ludfjig force-pushed the fix_release_notes branch 2 times, most recently from 9efd326 to 1031753 Compare March 12, 2025 00:03
Copy link

@Mossaka Mossaka left a comment

Choose a reason for hiding this comment

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

LGTM!

@marosset
Copy link
Contributor

LGTM

@marosset
Copy link
Contributor

This was hit in CI on one of the Ubuntu / KVM runners but I don't see how it is related to this PR...

cargo build --profile=dev
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.17s
cargo run --profile=dev --example metrics 
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.19s
     Running `target/debug/examples/metrics`
Error: [HYPERLIGHT] Handling disallowed syscall
Error: [HYPERLIGHT] Disallowed Syscall: 257
Segmentation fault (core dumped)
error: Recipe `run-rust-examples` failed on line 168 with exit code [13](https://github.com/hyperlight-dev/hyperlight/actions/runs/13818912127/job/38660020823?pr=348#step:15:14)9

@ludfjig ludfjig mentioned this pull request Mar 14, 2025
Copy link
Contributor

@dblnz dblnz left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@danbugs danbugs left a comment

Choose a reason for hiding this comment

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

Awesome stuff. LGTM

@ludfjig ludfjig force-pushed the fix_release_notes branch 2 times, most recently from 508ab95 to 033f77e Compare March 17, 2025 22:48
@ludfjig ludfjig requested a review from marosset March 17, 2025 23:41
@ludfjig ludfjig added the kind/enhancement For PRs adding features, improving functionality, docs, tests, etc. label Mar 17, 2025
@ludfjig ludfjig removed the request for review from marosset March 17, 2025 23:45
ludfjig added 3 commits March 18, 2025 11:01
Signed-off-by: Ludvig Liljenberg <[email protected]>
Signed-off-by: Ludvig Liljenberg <[email protected]>
@ludfjig ludfjig force-pushed the fix_release_notes branch from 033f77e to 2533c4d Compare March 18, 2025 18:01
@hyperlight-dev hyperlight-dev deleted a comment from Mossaka Mar 18, 2025
@hyperlight-dev hyperlight-dev deleted a comment from Mossaka Mar 18, 2025
@hyperlight-dev hyperlight-dev deleted a comment from danbugs Mar 18, 2025
@hyperlight-dev hyperlight-dev deleted a comment from marosset Mar 18, 2025
@hyperlight-dev hyperlight-dev deleted a comment from simongdavies Mar 18, 2025
@ludfjig
Copy link
Contributor Author

ludfjig commented Mar 18, 2025

Closing because unable to merge due to unresolved comments, even though there are no unresolved comments. Reopened as #368

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/infrastructure Concerns infrastructure rather than core functionality kind/enhancement For PRs adding features, improving functionality, docs, tests, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants