Update doc for releasing `v0.13.2`

juntao commented 10 months ago

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

Overall Summary: This GitHub Pull Request titled "Update doc for releasing v0.13.2" includes multiple commits with various changes, mainly focusing on updating workflows, versioning tables, and documentation. While most of the changes seem to be straightforward and do not pose potential problems, there are a few issues that need attention.

The first potential problem lies in the paths-ignore configuration of the rust-static-lib workflow. It is not clear why these specific paths are added and how they may impact the desired behavior of the workflow.

The matrix configuration for the build_ubuntu job in the rust-static-lib workflow has been updated without stating the reasons for including specific Rust versions. Some context would be helpful to understand the motivation behind these changes.

Another notable issue is a typo in the cmake command in the run script, which includes the redundancy of "cmake cmake" instead of just "cmake."

Furthermore, the flag -DWASMEDGE_BUILD_TOOLS=OFF has been set in the cmake command, but it is unclear if this aligns with the intended changes, as it would exclude building the tools. Verification is needed to ensure the alignment.

Regarding the updates to the ci(rust-static-lib) workflow, the commented out Build WasmEdge with Release mode step requires clarification on whether it should be re-enabled or not. Additionally, the relationship between the Install dependencies step and the commented step needs clarification.

Overall, this pull request introduces various changes, with the most notable issues being the potential problems mentioned above. It is recommended that the author addresses these concerns and provides additional context where needed for better clarity and understanding.

Details

Commit 14614a0d44b9329af7cf7c6c275ffa01a195b6fd

Key changes:

Updated workflows for CI build, rust-static-lib, and standalone.
Added paths to ignore for pull requests in the CI build and standalone workflows.
Updated the matrix of operating systems and Rust versions for the build_ubuntu job in the rust-static-lib workflow.

Potential problems:

It's unclear why the paths .github/workflows/rust-static-lib.yml, bindings/rust/, include/api/wasmedge/, and lib/api/** are added to the paths-ignore configuration in the push and pull_request events of the rust-static-lib workflow. This may affect the desired behavior of the workflow and should be reviewed.
The matrix configuration in the build_ubuntu job of the rust-static-lib workflow was updated to include Rust versions 1.73, 1.72, and 1.71, but the reasons for these specific versions are not stated. It would be helpful to have some context for these changes.

Commit 214c2e2d1f3f68bc98ff20c6b5890661b2153fbd

Key changes:

The versioning table in the wasmedge-sys crate's lib.rs file has been updated.

Potential problems:

There are no potential problems with this change as it only updates a versioning table in the code documentation.

Commit fb8da6d07a056b66af02fa9440bd043ad9358914

Key changes:

Updated the versioning table in both the README.md and src/lib.rs files.
Added the version 0.13.2 to the table.

Potential problems:

There are no potential problems identified in this patch.

Commit 3918ea63df7ef9bd58688f618fa72972f875cea0

Key changes:

Fixed a typo in the .github/workflows/rust-static-lib.yml file.

Potential problems:

There is a typo in the cmake command in the run script. The command "cmake cmake" should be changed to "cmake" to avoid this redundancy.

Commit 28086792e812707272ec9d34adc5b41e8f967241

Key changes:

The job in the .github/workflows/rust-static-lib.yml file has been updated.
The cmake command now includes the flag -DWASMEDGE_BUILD_TOOLS=OFF.

Potential problems:

It seems that the WASMEDGE_BUILD_TOOLS flag has been set to OFF in the cmake command. This means that the build process will not include building the tools. This may be intentional, but it should be verified if it aligns with the intended changes in this pull request.

Commit 513f18e49f6b37ee695b0e17afd94abd23e0706c

Key changes:

The version number in the documentation for wasmedge-sys has been updated from 0.13.1 to 0.13.2.

Potential problems:

None identified.

Commit 2adbc0af890a818b06a2d3b30081690660e5c468

Key changes:

Bumped the version of the Rust SDK to 0.13.2 in the Cargo.toml file.

Potential problems:

No potential problems found.

Commit 424706faef76f8863ab2f205048a913328ac7559

Key changes:

Updated version numbers in the versioning table in both the README.md file and lib.rs file.
The updated version is 0.13.2.

Potential problems:

No potential problems are identified in this patch.

Commit 0cfabfe292964ca834d8bf2f974e30da543d8ac1

Key changes:

Updated the ci(rust-static-lib) workflow in the .github/workflows/rust-static-lib.yml file.
Added an Install dependencies step to install necessary software dependencies.
Commented out the Build WasmEdge with Release mode step.
Added an Install Rust-nightly step using the dtolnay/rust-toolchain@nightly action.

Potential problems:

The Build WasmEdge with Release mode step has been commented out. It is unclear if this is intentional or if it should be re-enabled.
It is not clear if the Install dependencies step is meant to replace the commented out Build WasmEdge with Release mode step or if it needs to be executed before it.

Overall, it seems that the main intention of this patch is to update the workflow by adding an Install dependencies step and an Install Rust-nightly step. Some clarification is needed regarding the commented out step and the ordering of the steps.

apepkuss commented 10 months ago

@hydai Could you please help review this PR? Please ignore the failed rust-static-lib workflow. We'll fix it in another PR. Thanks a lot!

apepkuss commented 10 months ago

@hydai Thanks for the review!

WasmEdge / wasmedge-rust-sdk