Submitting bugs and fixes

August 14, 2024 · View on GitHub

Open an issue detailing the issue you've encountered or feature you would like to see.

Bug fixes and new features must be submitted using a pull request and pass CI to be included in the project.

Building

## needed to avoid errors with multiple projects calling and downloading the sdks at same time (https://github.com/bytecodealliance/componentize-dotnet/issues/8)
dotnet msbuild src/WitBindgen/build/BytecodeAlliance.Componentize.DotNet.WitBindgen.targets /t:PrepareWasmSdks
dotnet build

Testing

Run the tests:

dotnet test

tip: If you've already built the project you can speed up the tests by running dotnet test --no-build

Build Wasm tools locally

requires rust

The project is configured by default to pull tools such as wit-bindgen from their releases. It is possible to use custom builds of these tools via submodules:

## get submodules
git submodule update --int

## get latest code from configured branch
git submodule update --recursive --remote

## optional, change the branch for the project
cd modules/<project>
git checkout <branch>

Modify the WasmComponentSdk.csproj to enable building from source:

<BuildWasmToolsLocally>true</BuildWasmToolsLocally>

Modify the WitBindgen.csproj to enable building from source:

<BuildWitBindgenLocally>true</BuildWitBindgenLocally>

And then follow the project build steps.

Debugging

Create a msbuild debug log:

dotnet build /bl

View the log with https://www.msbuildlog.com/.

Learn more at trouble shooting techniques for msbuild.

Getting help

If you have any questions please drop a note in the c# zulip chat.

This project uses MSbuild and .NET Project SDKS. Learn more about this tooling in: