Automated Testing & Publishing

Automated testing, publishing, and code quality checks that run when you update your code, ensuring your rust code works across all platforms.

Key Features

• Cross-platform testing: Linux, Windows, macOS
• Automated code coverage: How much of your code is tested? (Codecov)
• Semantic version checking: Prevents breaking changes
• Tag-based publishing: crates.io, NuGet
• PGO optimization: Better performance
• Wine testing: Linux gaming compatibility

Testing Your Code

Cross-Platform Testing

Standard Targets

• Linux: x86_64, i686
• Windows: x86_64, i686 (MSVC toolchain)
• macOS: x86_64 (Intel), aarch64 (Apple Silicon)

Optional Extended Targets

1. Required for mods/code targeting older game consoles

Testing on Wine

The test-on-wine job ensures your code runs correctly inside Wine, which is crucial for low level development; which integrates tightly with the OS.

This is helpful when your code is expected to run in a Windows environment from Linux; such as being part of game mods.

Code Quality & Coverage

Code Coverage Reports

The default CI configuration collects and uploads coverage reports to Codecov for all supported platforms, showing you which parts of your code need more tests.

Excluding Crates from Coverage

To exclude specific crates from coverage, use the --workspace --exclude <crate-name> flags with cargo-tarpaulin:

GitHub Actions Configuration

- name: Run Tests and Upload Coverage
  uses: Reloaded-Project/devops-rust-test-and-coverage@v1
  with:
    additional-tarpaulin-flags: "--workspace --exclude my-cli-tool"

VS Code Tasks

Update your .vscode/tasks.json to include the exclusion flags:

{
  "label": "Auto Coverage on Save",
- "command": "cargo install cargo-tarpaulin --quiet && cargo watch -x \"tarpaulin --skip-clean --out Xml --out Html --engine llvm --target-dir target/coverage-build\" -w src/"
+ "command": "cargo install cargo-tarpaulin --quiet && cargo watch -x \"tarpaulin --skip-clean --out Xml --out Html --engine llvm --target-dir target/coverage-build --workspace --exclude my-cli-tool\" -w src/"
}

The task automatically runs in the src/ directory, so you don't need to manually navigate when using VSCode tasks.

Semantic Version Checks

Automatically checks if your changes might break code for people who use your library. If you make changes that could break other people's code, you'll need to update your version number. This prevents accidental breaking changes from reaching your users.

Publishing Your Library

How Publishing Works

When you push a version tag, the CI workflow automatically handles your release process.

What Gets Published

Depending on your template options, the following may happen:

• crates.io: Publishes your Rust library to the official Rust package registry
• GitHub Release: Creates a GitHub release with changelog

Optional features (if enabled):

• NuGet: Publishes .NET bindings for C# developers
• C/C++ Headers: Generates header files for cross-language interoperability

All releases are gated by successful tests and quality checks, ensuring only stable code reaches your users.

Integrate with Non-Template Projects

Run the template again with your desired options to generate a customized rust.yml file, then copy it to your project:

cargo generate --git https://github.com/Reloaded-Project/reloaded-templates-rust.git

See the main documentation for more details on getting started with cargo-generate.