Travis CI and AppVeyor template to test your Rust crate on 5 architectures and publish binary releases of it for Linux, macOS and Windows
CI test your crate (library or binary) on Linux, macOS and Windows and on more than just the x86 architecture.
Cargo artifacts are cached and reused between CI builds.
"Deploys": Publish binary releases of your application by just pushing a new (Git) tag.
Use this template
ci directory, and the
appveyor.yml files into the repository where you host your Rust crate.
You'll have to adjust those files to meet your needs. Just look inside those files for comments that start with the word
TODO; they'll tell you want needs to be changed.
This is an overview of what must / can be changed:
The GitHub token used for deploys.
The list of test targets. Trim it down to reduce test times.
The Rust channel used for testing / deploys.
The "test phase". Tweak how your crate is tested.
the "package phase". Tweak what goes into the release tarball / zipfile.
Generate binary releases
You only need to push an annotated tag to kick off the build process.
# Optional: Publish a new version of your crate to crates.io $ cargo publish $ git tag -a $TAG $ git push origin $TAG
Use the binary releases on Travis CI
install.sh script that you can use to quickly install a binary release produced using this CI template.
$ curl -LSfs https://japaric.github.io/trust/install.sh | \ sh -s -- --git japaric/cross
For more details about this installation script see
How to disable deploys?
If you don't want to generate binary releases at all, perhaps because your Cargo project is a library or you only want to test your project, then you can simply change
appveyor.yml, to always be false. For example:
# .travis.yml deploy: on: condition: $DEPLOY = never
How to upgrade your CI configuration?
First, figure out which version of the trust template you are using. The version is written in the header of the
appveyor.yml files. If there's no header, that means you are using version
Next, look at the change log to check if there's a new release and to learn, at a high level, how the template has changed: what has been fixed, what has been added, etc.
If it makes sense for you to upgrade, you can see the required "code" changes by looking at the "diff" between the version you are using and the version you are going to upgrade to. For example:
As for the upgrade itself, GitHub can generate a patch from the above diff that then you can apply to your repository with
git am or similar:
If you run into any problem with any of these targets, report them to
cross's issue tracker but first check if using a newer release (see
ci/install.sh) would fix your problem.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.