https://github.com/vrixyz/bevy_jam_2

https://github.com/vrixyz/bevy_jam_2

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/vrixyz/bevy_jam_2
• Owner: Vrixyz
• License: other
• Created: 2022-08-21T11:17:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-26T13:26:37.000Z (over 2 years ago)
• Last Synced: 2024-10-30T00:04:45.328Z (3 months ago)
• Language: Rust
• Size: 304 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bevy GitHub CI Template

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

It creates two workflows:

* [CI](#CI)

* [Release](#Release)

## CI

Definition: [.github/workflows/ci.yaml](./.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](./.github/workflows/ci.yaml) to use those.

## Release

Definition: [.github/workflows/release.yaml](./.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](./.github/workflows/release.yaml).

### Git Tag from GitHub UI

You can follow [Managing releases in a repository](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)

### Git Tag from the CLI

Execute the following commands: 

```sh

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](

https://github.com/bevyengine/bevy_github_ci_template/releases/tag/my-game-1.0).