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

Refactor: expose AsyncRuntime Oneshot via trait #1200

Merged

Conversation

SteveLauC
Copy link
Collaborator

@SteveLauC SteveLauC commented Jul 25, 2024

What does this PR do

Exposes Oneshot via trait Oneshot.

Closes #1198

Checklist

  • Updated guide with pertinent info (may not always apply).
  • Squash down commits to one or two logical commits which clearly describe the work you've done.
  • Unittest is a friend:)

This change is Reviewable

@SteveLauC
Copy link
Collaborator Author

Do I need to include a changelog entry in the PR description? Something like

Changelog

Change: Interfaces of the oneshot channel in AsyncRunime have their own trait trait Oneshot now

@drmingdrmer drmingdrmer self-requested a review July 25, 2024 05:50
@drmingdrmer
Copy link
Member

Do I need to include a changelog entry in the PR description? Something like

Changelog

Change: Interfaces of the oneshot channel in AsyncRunime have their own trait trait Oneshot now

Use a commit message starts withChange: , instead of a Refactor: for a breaking change. It will be included in the change log when publishing. No need to add another # Changelog entry in the commit message.

The PR title is not used when building change log.

Copy link
Member

@drmingdrmer drmingdrmer left a comment

Choose a reason for hiding this comment

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

Nice shot. Thank you!

Reviewed 6 of 6 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @SteveLauC)

@drmingdrmer drmingdrmer merged commit 8b789e3 into databendlabs:main Jul 25, 2024
32 checks passed
@SteveLauC SteveLauC deleted the Refactor/uniform_channel_interface branch July 25, 2024 06:06
@SteveLauC
Copy link
Collaborator Author

SteveLauC commented Jul 25, 2024

Use a commit message starts withChange: , instead of a Refactor: for a breaking change.

This is a breaking change for users who implement their own AsyncRuntime, do you need to manually edit the changelog when crafting a new release?

@drmingdrmer
Copy link
Member

Use a commit message starts withChange: , instead of a Refactor: for a breaking change.

This is a breaking change for users who implement their own AsyncRuntime, do you need to manually edit the changelog when crafting a new release?

The change log is built with this script:
https://github.com/datafuselabs/openraft/blob/main/scripts/build_change_log.py

After that, the generated change-log still needs a few manually update.

@SteveLauC
Copy link
Collaborator Author

The change log is built with this script:
https://github.com/datafuselabs/openraft/blob/main/scripts/build_change_log.py

After that, the generated change-log still needs a few manually update.

Get it, thanks for showing me this!

@drmingdrmer
Copy link
Member

Use a commit message starts withChange: , instead of a Refactor: for a breaking change.

This is a breaking change for users who implement their own AsyncRuntime, do you need to manually edit the changelog when crafting a new release?

I forgot the commit message needs to be updated when merging. I've force-pushed the main branch to correct the commit message...

@SteveLauC
Copy link
Collaborator Author

I forgot the commit message needs to be updated when merging. I've force-pushed the main branch to correct the commit message...

Thanks for fixing that for me! 😄

@SteveLauC SteveLauC mentioned this pull request Jul 25, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Uniform AsyncRuntime channel interfaces
2 participants