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

[Doc] Update CHANGELOG #45

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Conversation

apepkuss
Copy link
Collaborator

@apepkuss apepkuss commented Aug 1, 2023

In this PR update CHANGELOG.

Copy link
Member

juntao commented Aug 1, 2023

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Overall Summary:

This pull request includes a set of key changes that involve adding new features, refactoring code with breaking changes, and updating documentation. There are several potential problems to address:

  1. Breaking changes: The patch includes several breaking changes, so it is important to ensure that all affected code is updated accordingly and any potential impact on existing code is addressed.
  2. Lack of context: It is unclear why certain changes were made and the reasoning behind them. It would be helpful to have more context or explanations for these changes in the changelog or commit message.
  3. Missing information in the changelog: The changelog does not mention any bug fixes or other improvements apart from the new features and refactorings. It would be good to include such information if applicable.
  4. Lack of detail in the Rust SDK API Document update: The key change related to the Rust SDK API Document update lacks detailed information. Providing more details about the updates would be beneficial.

The most important findings include the need to ensure that breaking changes are properly addressed, and to provide more context and information in the documentation and commit messages. Additionally, it is important to update the changelog with any bug fixes or improvements made.

Details

Commit 2afdb74d93dd8b87d7bfecff93bfb6166da01fbe

Key Changes:

  • Added new features:
    • Func::wrap_async_func_with_type was added
    • WasiInstance::exit_code was added in async mod
    • WasiInstance::name was added in wasi mod
    • WasiContext was added
    • VmBuilder::with_wasi_context was added
  • Refactored code with several breaking changes:
    • Func::new was renamed Func::wrap_with_type
    • Type of data argument in Func::new and Func::wrap_func changed to Option<Box<T>>
    • WasiInstance was moved to async mod and several methods were removed
    • AsyncState was moved into async mod
    • HostFn<T> and AsyncHostFn<T> were removed
    • ImportObjectBuilder was updated with several changes
    • ImportObject now has a generic type parameter
    • PluginModuleBuilder and PluginModule were updated with several changes
    • Store::register_import_module now has a generic type parameter
    • async_host_function proc-macro was updated
    • Vm was updated and imports field was removed
    • Vm::register_import_module now has a different signature
    • VmBuilder::build was updated
    • standalone deployment mode was improved
  • Documentation was updated including README.md and Rust SDK API Document.

Potential Problems:

  • The patch includes several breaking changes. It is important to ensure that all affected code is updated accordingly and any potential impact on existing code is addressed.
  • It's unclear why certain changes were made and the reasoning behind them. It would be helpful to have more context or explanations for these changes in the changelog or commit message.
  • The changelog does not mention any bug fixes or other improvements apart from the new features and refactorings. It would be good to include such information if applicable.

Commit 0cda1f9e3e361e2fcfaf51675c88ba9d301dff86

Key changes:

Potential problems:

  • It would be helpful to have more detailed information about the changes made in the Rust SDK API Document update.

@apepkuss apepkuss requested a review from L-jasmine August 1, 2023 07:07
@apepkuss apepkuss merged commit d8e8f30 into WasmEdge:main Aug 1, 2023
1 check passed
@apepkuss
Copy link
Collaborator Author

apepkuss commented Aug 1, 2023

@L-jasmine Thanks for the review!

@apepkuss apepkuss deleted the doc/update-changelog branch August 1, 2023 07:09
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.

3 participants