Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spectralops/rust-ci-release-template

A Github Actions based CI release template for Rust binaries
https://github.com/spectralops/rust-ci-release-template

ci rust rust-lang tools

Last synced: about 1 month ago
JSON representation

A Github Actions based CI release template for Rust binaries

Host: GitHub
URL: https://github.com/spectralops/rust-ci-release-template
Owner: SpectralOps
License: apache-2.0
Created: 2021-09-20T13:43:05.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2022-05-30T05:41:42.000Z (over 2 years ago)
Last Synced: 2023-06-04T09:15:32.982Z (over 1 year ago)
Topics: ci, rust, rust-lang, tools
Language: Rust
Homepage:
Size: 48.8 KB
Stars: 67
Watchers: 4
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Rust CI Release Template

_A Github Actions based CI release template._

This repo serves as a live template, and reference for building your own CI powered Rust release process on Github Action. This was built to [fill a gap](https://www.reddit.com/r/rust/comments/bjwygr/rust_needs_a_rustreleaser/) that Rust has, and Go doesn't have because Go has [GoReleaser](https://github.com/goreleaser/goreleaser).

Heavily inspired from the [helix](https://github.com/helix-editor/helix) editor project CI workflow + some small tweaks.

**Development**
On each commit, the following is automated:

* CI with caching: check, test, lint

**Release**
Upon pushing a new tag, the following is automated:

* Build for multi-platform binaries: Linux, Windows, macOS
* Create GitHub releases
* Update Homebrew formula

## Quick Start

Just copy `.github/workflows` to your own repo, and set a binary name in your own `Cargo.toml` using a `[[bin]]` block (see the example [Cargo.toml](Cargo.toml)).

Next, check out the point of interest for you to configure / tune below.

## Points of interest

* [Cargo.toml](Cargo.toml) - set your binary name explicitly and take note of it
* [build.yml](.github/workflows/build.yml) - you can use as-is, no parameters to configure
* [release.yml](.github/workflows/release.yml)
- Project: at the top of the file, set your own parameters under `env`
- Project: your binary name should be the same as in your `Cargo.toml`
- Targets: configure platforms as you wish
- Homebrew: remove the Homebrew pragma if not needed
- Homebrew: macOS with ARM chips: customize your formula

# Thanks

To all [Contributors](https://github.com/spectralops/rust-ci-release-template/graphs/contributors) - you make this happen, thanks!