Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/japaric/trust

Travis CI and AppVeyor template to test your Rust crate on 5 architectures and publish binary releases of it for Linux, macOS and Windows
https://github.com/japaric/trust

bsd continuous-integration cross-compilation cross-testing linux macos rust template windows

Last synced: 6 days ago
JSON representation

Travis CI and AppVeyor template to test your Rust crate on 5 architectures and publish binary releases of it for Linux, macOS and Windows

Awesome Lists containing this project

README 

        
# `trust`



> Travis CI and AppVeyor template to test your Rust crate on 5 architectures

> and publish [binary releases] of it for Linux, macOS and Windows



[binary releases]: https://github.com/japaric/trust/releases



### Features



- 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.



## Requirements



- Your crate must be hosted on GitHub (free).



- A [Travis CI](https://travis-ci.org/) account (free).



- An [AppVeyor](https://www.appveyor.com/) account (free).



## How-to



### Use this template



Copy the `ci` directory, and the `.travis.yml` and `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



There's

an [`install.sh`](https://github.com/japaric/trust/blob/gh-pages/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 `install.sh -h`



### 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 `deploy.on.condition`, in `.travis.yml`, and `deploy.on`, in

`appveyor.yml`, to always be false. For example:



``` yml

# .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 `.travis.yml` and `appveyor.yml` files. If

there's no header, that means you are using version `v0.1.0`.



Next, look at the [change log](CHANGELOG.md) 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:



https://github.com/japaric/trust/compare/v0.1.0...v0.1.1



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:



https://github.com/japaric/trust/compare/v0.1.0...v0.1.1.patch



## Supported targets



### Linux



Courtesy of [`cross`](https://github.com/japaric/cross).



If you run into any problem with any of these targets, report them

to [`cross`'s issue tracker](https://github.com/japaric/cross/issues) but first

check if using a newer release (see `ci/install.sh`)

would

[fix your problem](https://github.com/japaric/cross/blob/master/CHANGELOG.md).



### Android



- aarch64-linux-android



- arm-linux-androideabi



- armv7-linux-androideabi



- i686-linux-android



- x86_64-linux-android



### iOS



- aarch64-apple-ios



- armv7-apple-ios



- armv7s-apple-ios



- i386-apple-ios



- x86_64-apple-ios



### Linux



- `i686-unknown-linux-gnu`



- `i686-unknown-linux-musl`



- `x86_64-unknown-linux-gnu`



- `x86_64-unknown-linux-musl`



- `aarch64-unknown-linux-gnu`



- `arm-unknown-linux-gnueabi`



- `armv7-unknown-linux-gnueabihf`



- `mips-unknown-linux-gnu`



- `mips64-unknown-linux-gnuabi64`



- `mips64el-unknown-linux-gnuabi64`



- `mipsel-unknown-linux-gnu`



- `powerpc-unknown-linux-gnu`



- `powerpc64-unknown-linux-gnu`



- `powerpc64le-unknown-linux-gnu`



- `s390x-unknown-linux-gnu`



### macOS



- `i686-apple-darwin`



- `x86_64-apple-darwin`



### *BSD



- `i686-unknown-freebsd`



- `x86_64-unknown-freebsd`



- `x86_64-unknown-netbsd`



### Windows (MinGW)



- `i686-pc-windows-gnu`



- `x86_64-pc-windows-gnu`



### Windows (MSVC)



- `i686-pc-windows-msvc`



- `x86_64-pc-windows-msvc`



## License



Licensed under either of



- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  https://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)



at your option.



### Contribution



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.