https://github.com/tokio-rs/cargo-tokio
A cargo subcommand to help building the Tokio project.
https://github.com/tokio-rs/cargo-tokio
Last synced: 4 months ago
JSON representation
A cargo subcommand to help building the Tokio project.
- Host: GitHub
- URL: https://github.com/tokio-rs/cargo-tokio
- Owner: tokio-rs
- License: mit
- Created: 2020-12-16T15:45:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-16T22:59:11.000Z (over 4 years ago)
- Last Synced: 2024-04-13T21:55:11.118Z (about 1 year ago)
- Language: Rust
- Size: 16.6 KB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cargo Tokio
## Overview
This cargo subcomand aims to simplify the development process. It gives an easy way
to perform locally the commands that are performed by the CI tool.
## Installation
```sh
cargo install cargo-tokio
```
## Examples
```sh
# runs **all** CISteps
cargo tokio
```
```sh
# runs loom tests
cargo tokio loom
```
```sh
# runs the test-unstable suite
cargo tokio test-unstable
```
## Project structure
`ci.rs`:
- `TokioCIStage` are commands typically defined through the `TokioCIStageBuilder`.
These are mostly `cargo test`, `cargo hack`, etc. Usually multiple `TokioCIStage`
make a `TokioCIStep`.
- `TokioCIStep` corresponds to a step in the CI. `miri`, `loom`, `san`, `clippy` would be
different CI steps.
`cli.rs`:
- Command line options to run the tool.
`main.rs`:
- Glues everything so that it can run as an executable.
## Contributing
Ideally this command should mirror any updates on the `.github/` directory on the
[tokio](https://github.com/tokio-rs/tokio) crate. So if there's anything missing, feel free
to submit a PR.
## License
This project is licensed under the [MIT license].
[MIT license]: https://github.com/tokio-rs/cargo-tokio/blob/master/LICENSE
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Tokio by you, shall be licensed as MIT, without any additional
terms or conditions.