Bevy GitHub CI Template

This repo show how to setup CI on a github project for Bevy.

It creates two workflows:

• CI
• Release

CI

Definition: .github/workflows/ci.yaml

This workflow runs on every commit to main branch, and on every PR targetting the main branch.

It will use rust stable on linux, with cache between different executions, those commands:

• cargo test
• cargo clippy -- -D warnings
• cargo fmt --all -- --check

If you are using anything OS specific or rust nightly, you should update the file ci.yaml to use those.

Release

Definition: .github/workflows/release.yaml

This workflow runs on every tag.

It will build:

• For Linux and Windows, a .zip archive containing the executable and the assets.
• For macOS, a dmg image with a .app containing the assets.
• For wasm, a .zip archive with the wasm binary, the js bindings, an html file loading it, and the assets.

If you don't want to target some of those platforms, you can remove the corresponding job from the file release.yaml.

Git Tag from GitHub UI

You can follow Managing releases in a repository

Git Tag from the CLI

Execute the following commands:

git tag -a "my-game-1.0" -m "First official release"
git push --tags

Result

A new release will be available in GitHub, with the archives per platform availble as downloadable assets.

The git commands above produced this release: my-game-1.0.