Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/fnichol/fnichol-cime

A demonstration of a Rust CI build/test/release workflow supporting multi-platform testing, binary builds, Docker image building, and Crates.io publishing.
https://github.com/fnichol/fnichol-cime
ci cirrus-ci docker-image freebsd github-releases linux macos project-template rust windows
Last synced: 24 days ago
JSON representation
A demonstration of a Rust CI build/test/release workflow supporting multi-platform testing, binary builds, Docker image building, and Crates.io publishing.
Host: GitHub
URL: https://github.com/fnichol/fnichol-cime
Owner: fnichol
License: mpl-2.0
Created: 2021-02-21T21:04:47.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2023-06-08T00:02:26.000Z (over 1 year ago)
Last Synced: 2024-10-01T15:53:54.770Z (about 1 month ago)
Topics: ci, cirrus-ci, docker-image, freebsd, github-releases, linux, macos, project-template, rust, windows
Language: Shell
Homepage:
Size: 88.9 KB
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        


  


  fnichol-cime

  






  A demonstration of a Rust CI build/test/release workflow supporting

  multi-platform testing, binary builds, Docker image building, and Crates.io

  publishing.



|                  |                                                                                          |

| ---------------: | ---------------------------------------------------------------------------------------- |

|               CI | [![CI Status][badge-ci-overall]][ci]
 [![Bors enabled][badge-bors]][bors-dashboard] |

|   Latest Version | [![Latest version][badge-version]][crate]                                                |

|    Documentation | [![Documentation][badge-docs]][docs]                                                     |

|  Crate Downloads | [![Crate downloads][badge-crate-dl]][crate]                                              |

| GitHub Downloads | [![Github downloads][badge-github-dl]][github-releases]                                  |

|     Docker Pulls | [![Docker pulls][badge-docker-pulls]][docker]                                            |

|          License | [![Crate license][badge-license]][github]                                                |

Table of Contents

- [CLI](#cli)

  - [Usage](#usage)

  - [Installation](#installation)

    - [install.sh (Pre-Built Binaries)](#installsh-pre-built-binaries)

    - [GitHub Releasees (Pre-Built Binaries)](#github-releasees-pre-built-binaries)

    - [Docker Image](#docker-image)

    - [Cargo Install](#cargo-install)

    - [From Source](#from-source)

- [Library](#library)

  - [Usage](#usage-1)

  - [Examples](#examples)

    - [Example: greeting a human](#example-greeting-a-human)

- [CI Status](#ci-status)

  - [Build (main branch)](#build-main-branch)

  - [Test (main branch)](#test-main-branch)

  - [Check (main branch)](#check-main-branch)

- [Code of Conduct](#code-of-conduct)

- [Issues](#issues)

- [Contributing](#contributing)

- [Release History](#release-history)

- [Authors](#authors)

- [License](#license)

## CLI

### Usage

There's not much to this program. To greet the currently logged in user, run:

```sh

> fnichol-cime "$USER"

Hello, jdoe!

```

For more help and full usage, use the `--help` or `-h` flags:

```sh

> fnichol-cime --help

```

### Installation

#### install.sh (Pre-Built Binaries)

An installer is provided at 

which installs a suitable pre-built binary for common systems such as Linux,

macOS, Windows, and FreeBSD. It can be downloaded and run locally or piped into

a shell interpreter in the "curl-bash" style as shown below. Note that if you're

opposed to this idea, feel free to check some of the alternatives below.

To install the latest release for your system into `$HOME/bin`:

```console

> curl -sSf https://fnichol.github.io/fnichol-cime/install.sh | sh

```

When the installer is run as `root` the installation directory defaults to

`/usr/local/bin`:

```console

> curl -sSf https://fnichol.github.io/fnichol-cime/install.sh | sudo sh

```

A [nightly] release built from `HEAD` of the main branch is available which can

also be installed:

```console

> curl -sSf https://fnichol.github.io/fnichol-cime/install.sh \

    | sh -s -- --release=nightly

```

For a full set of options, check out the help usage with:

```console

> curl -sSf https://fnichol.github.io/fnichol-cime/install.sh \

    | sh -s -- --help

```

#### GitHub Releasees (Pre-Built Binaries)

Each release comes with binary artifacts published in [GitHub

Releases][github-releases]. The `install.sh` program downloads its artifacts

from this location so this serves as a manual alternative. Each artifact ships

with MD5 and SHA256 checksums to help verify the artifact on a target system.

#### Docker Image

A minimal image ships with each release (including a [nightly] built version

from `HEAD` of the main branch) published to [Docker Hub][docker]. The

entrypoint invokes the binary directly, so any arguments to `docker run` will be

passed to the program. For example, to display the full help usage:

```console

> docker run fnichol/fnichol-cime --help

```

#### Cargo Install

If [Rust](https://rustup.rs/) is installed on your system, then installing with

Cargo is straight forward with:

```console

> cargo install fnichol-cime

```

#### From Source

To install from source, you can clone the Git repository, build with Cargo and

copy the binary into a destination directory. This will build the project from

the latest commit on the main branch, which may not correspond to the latest

stable release:

```console

> git clone https://github.com/fnichol/fnichol-cime.git

> cd fnichol-cime

> cargo build --release

> cp ./target/release/fnichol-cime /dest/path/

```

---

## Library

This crate executes a highly specialized algorithm to dynamically generate a

greeting in english to a given subject. It is serious business.

### Usage

This crate is on [crates.io](https://crates.io/crates/fnichol-cime) and can be

used by adding the crate to your dependencies in your project's `Cargo.toml`

file:

```toml

[dependencies]

fnichol-cime = { version = "0.7.0", default-features = false }

```

Note that the default features include dependencies which are required to build

a CLI and are not needed for the library.

### Examples

#### Example: greeting a human

Assuming we have a human named `Jane`:

```rust

let greeting = fnichol_cime::greeting("Jane");

// #=> "Hello, Jane!"

```

## CI Status

### Build (main branch)

| Operating System | Target                        | Stable Rust                                                                     |

| ---------------: | ----------------------------- | ------------------------------------------------------------------------------- |

|          FreeBSD | `x86_64-unknown-freebsd`      | [![FreeBSD Build Status][badge-ci-build-x86_64-unknown-freebsd]][ci-staging]    |

|            Linux | `arm-unknown-linux-gnueabihf` | [![Linux Build Status][badge-ci-build-arm-unknown-linux-gnueabihf]][ci-staging] |

|            Linux | `aarch64-unknown-linux-gnu`   | [![Linux Build Status][badge-ci-build-aarch64-unknown-linux-gnu]][ci-staging]   |

|            Linux | `i686-unknown-linux-gnu`      | [![Linux Build Status][badge-ci-build-i686-unknown-linux-gnu]][ci-staging]      |

|            Linux | `i686-unknown-linux-musl`     | [![Linux Build Status][badge-ci-build-i686-unknown-linux-musl]][ci-staging]     |

|            Linux | `x86_64-unknown-linux-gnu`    | [![Linux Build Status][badge-ci-build-x86_64-unknown-linux-gnu]][ci-staging]    |

|            Linux | `x86_64-unknown-linux-musl`   | [![Linux Build Status][badge-ci-build-x86_64-unknown-linux-musl]][ci-staging]   |

|            macOS | `x86_64-apple-darwin`         | [![macOS Build Status][badge-ci-build-x86_64-apple-darwin]][ci-staging]         |

|          Windows | `x86_64-pc-windows-msvc`      | [![Windows Build Status][badge-ci-build-x86_64-pc-windows-msvc]][ci-staging]    |

### Test (main branch)

| Operating System | Stable Rust                                                               | Nightly Rust                                                                |

| ---------------: | ------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

|          FreeBSD | [![FreeBSD Stable Test Status][badge-ci-test-stable-freebsd]][ci-staging] | [![FreeBSD Nightly Test Status][badge-ci-test-nightly-freebsd]][ci-staging] |

|            Linux | [![Linux Stable Test Status][badge-ci-test-stable-linux]][ci-staging]     | [![Linux Nightly Test Status][badge-ci-test-nightly-linux]][ci-staging]     |

|            macOS | [![macOS Stable Test Status][badge-ci-test-stable-macos]][ci-staging]     | [![macOS Nightly Test Status][badge-ci-test-nightly-macos]][ci-staging]     |

|          Windows | [![Windows Stable Test Status][badge-ci-test-stable-windows]][ci-staging] | [![Windows Nightly Test Status][badge-ci-test-nightly-windows]][ci-staging] |

**Note**: The

[Minimum Supported Rust Version (MSRV)](https://github.com/rust-lang/rfcs/pull/2495)

is also tested and can be viewed in the [CI dashboard][ci-staging].

### Check (main branch)

|        | Status                                                |

| ------ | ----------------------------------------------------- |

| Lint   | [![Lint Status][badge-ci-check-lint]][ci-staging]     |

| Format | [![Format Status][badge-ci-check-format]][ci-staging] |

## Code of Conduct

This project adheres to the Contributor Covenant [code of

conduct][code-of-conduct]. By participating, you are expected to uphold this

code. Please report unacceptable behavior to [email protected].

## Issues

If you have any problems with or questions about this project, please contact us

through a [GitHub issue][issues].

## Contributing

You are invited to contribute to new features, fixes, or updates, large or

small; we are always thrilled to receive pull requests, and do our best to

process them as fast as we can.

Before you start to code, we recommend discussing your plans through a [GitHub

issue][issues], especially for more ambitious contributions. This gives other

contributors a chance to point you in the right direction, give you feedback on

your design, and help you find out if someone else is working on the same thing.

## Release History

See the [changelog] for a full release history.

## Authors

Created and maintained by [Fletcher Nichol][fnichol] ().

## License

Licensed under the Mozilla Public License Version 2.0 ([LICENSE.txt][license]).

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the MIT license, shall be

licensed as above, without any additional terms or conditions.

[badge-bors]: https://bors.tech/images/badge_small.svg

[badge-ci-build-x86_64-unknown-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-x86_64-unknown-freebsd.tar.gz

[badge-ci-build-arm-unknown-linux-gnueabihf]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-arm-unknown-linux-gnueabihf.tar.gz

[badge-ci-build-aarch64-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-aarch64-unknown-linux-gnu.tar.gz

[badge-ci-build-i686-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-i686-unknown-linux-gnu.tar.gz

[badge-ci-build-i686-unknown-linux-musl]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-i686-unknown-linux-musl.tar.gz

[badge-ci-build-x86_64-unknown-linux-gnu]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-x86_64-unknown-linux-gnu.tar.gz

[badge-ci-build-x86_64-unknown-linux-musl]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-x86_64-unknown-linux-musl.tar.gz

[badge-ci-build-x86_64-apple-darwin]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-x86_64-apple-darwin.zip

[badge-ci-build-x86_64-pc-windows-msvc]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=build-bin-fnichol-cime-x86_64-pc-windows-msvc.zip

[badge-ci-check-format]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=check&script=format

[badge-ci-check-lint]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=check&script=lint

[badge-ci-overall]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/main?style=flat-square

[badge-ci-test-nightly-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-nightly-x86_64-unknown-freebsd

[badge-ci-test-nightly-linux]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-nightly-x86_64-unknown-linux-gnu

[badge-ci-test-nightly-macos]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-nightly-x86_64-apple-darwin

[badge-ci-test-nightly-windows]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-nightly-x86_64-pc-windows-msvc

[badge-ci-test-stable-freebsd]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-stable-x86_64-unknown-freebsd

[badge-ci-test-stable-linux]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-stable-x86_64-unknown-linux-gnu

[badge-ci-test-stable-macos]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-stable-x86_64-apple-darwin

[badge-ci-test-stable-windows]:

  https://img.shields.io/cirrus/github/fnichol/fnichol-cime/staging?style=flat-square&task=test-stable-x86_64-pc-windows-msvc

[badge-crate-dl]:

  https://img.shields.io/crates/d/fnichol-cime.svg?style=flat-square

[badge-docker-pulls]:

  https://img.shields.io/docker/pulls/fnichol/fnichol-cime.svg?style=flat-square

[badge-docs]: https://docs.rs/fnichol-cime/badge.svg?style=flat-square

[badge-github-dl]:

  https://img.shields.io/github/downloads/fnichol/fnichol-cime/total.svg

[badge-license]:

  https://img.shields.io/crates/l/fnichol-cime.svg?style=flat-square

[badge-version]:

  https://img.shields.io/crates/v/fnichol-cime.svg?style=flat-square

[bors-dashboard]: https://app.bors.tech/repositories/32089

[changelog]: https://github.com/fnichol/fnichol-cime/blob/main/CHANGELOG.md

[ci]: https://cirrus-ci.com/github/fnichol/fnichol-cime

[ci-staging]: https://cirrus-ci.com/github/fnichol/fnichol-cime/staging

[code-of-conduct]:

  https://github.com/fnichol/fnichol-cime/blob/main/CODE_OF_CONDUCT.md

[crate]: https://crates.io/crates/fnichol-cime

[docker]: https://hub.docker.com/r/fnichol/fnichol-cime

[docs]: https://docs.rs/fnichol-cime

[fnichol]: https://github.com/fnichol

[github]: https://github.com/fnichol/fnichol-cime

[github-releases]: https://github.com/fnichol/fnichol-cime/releases

[issues]: https://github.com/fnichol/fnichol-cime/issues

[license]: https://github.com/fnichol/fnichol-cime/blob/main/LICENSE.txt

[nightly]: https://github.com/fnichol/fnichol-cime/releases/tag/nightly