From 6aae5683fcc153ab25b82f20b55d8c2549ce9e73 Mon Sep 17 00:00:00 2001 From: Kaur Kuut Date: Sun, 1 Feb 2026 22:19:47 +0200 Subject: [PATCH 1/2] Migrate to a single source of truth for the readme. --- README.md | 72 -------------------------------------------------- prep/README.md | 6 +++++ 2 files changed, 6 insertions(+), 72 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index c934195..0000000 --- a/README.md +++ /dev/null @@ -1,72 +0,0 @@ -
- -# Prep - -**Prepare Rust projects for greatness** - -[![Latest published version.](https://img.shields.io/crates/v/prep.svg)](https://crates.io/crates/prep) -[![Dependency staleness status.](https://deps.rs/crate/prep/latest/status.svg)](https://deps.rs/crate/prep) -[![Apache 2.0 or MIT license.](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](#license) - -
- -Prep is a cross-platform CLI tool that provides Rust workspace verification in a single short command. -You can just invoke `prep ci` and if the checks succeed then you can rest easy knowing that your PR won't fail CI. - -The latest version is [0.1.0] which was published on 2026-01-31. -You can read about the changes in the [changelog]. - -## Motivation - -Rust projects tend to have a wide variety of fairly complicated verification steps in CI. -These steps help ensure that the project stays consistent and keeps working in various scenarios. - -However, these CI steps are either written as GitHub Action YAML files or as Bash scripts. -Running GitHub Actions requires a rather heavyweight Docker image, which expects a Unix userland, just like Bash scripts. -Additionally, they target ephemeral VMs, so they do a lot of tooling setup that isn't efficient for a local machine. -All of that meaning that you're really out of luck on Windows and even on Unix it's going to be needlessly cumbersome. - -So you need to analyze the specifics of a project's CI and craft custom local scripts to emulate the CI steps. -That, or you just manually invoke a few Cargo commands and hope for the best, leading to frequent CI failures on your PRs. -Which sucks because CI tends to run at a lot slower speed than your local machine, especially due to cold build cache. - -## Prep to the rescue - -Before opening a PR you can just run `prep ci` locally and verify that everything matches CI expectations. -Because Prep aims for a rather robust set of verifications this will be beneficial even when the project still uses custom CI scripts. -However, for best results the project itself should run `prep ci` in its CI instead of custom scripts. -That way the only problems that remain uncaught locally are platform specific, which the CI will catch with its multi-platform job matrix. - -## Installation - -```sh -cargo install prep --locked -``` - -## Usage - -``` -Usage: prep [command] [options] - -Commands: - ci Verify for CI. - clp clippy Analyze with Clippy. - fmt format Format with rustfmt. - help Print help for the provided command. - -Options: - -h --help Print help for the provided command. - -V --version Print version information. -``` - -## License - -Licensed under either of - -- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or ) -- MIT license ([LICENSE-MIT](LICENSE-MIT) or ) - -at your option. - -[0.1.0]: https://github.com/Nevermore/prep/releases/tag/v0.1.0 -[changelog]: prep/CHANGELOG.md diff --git a/prep/README.md b/prep/README.md index 434384b..c934195 100644 --- a/prep/README.md +++ b/prep/README.md @@ -13,6 +13,9 @@ Prep is a cross-platform CLI tool that provides Rust workspace verification in a single short command. You can just invoke `prep ci` and if the checks succeed then you can rest easy knowing that your PR won't fail CI. +The latest version is [0.1.0] which was published on 2026-01-31. +You can read about the changes in the [changelog]. + ## Motivation Rust projects tend to have a wide variety of fairly complicated verification steps in CI. @@ -64,3 +67,6 @@ Licensed under either of - MIT license ([LICENSE-MIT](LICENSE-MIT) or ) at your option. + +[0.1.0]: https://github.com/Nevermore/prep/releases/tag/v0.1.0 +[changelog]: prep/CHANGELOG.md From bf30406d17517deaf97c82c2c467593bf9796c18 Mon Sep 17 00:00:00 2001 From: Kaur Kuut Date: Sun, 1 Feb 2026 22:23:12 +0200 Subject: [PATCH 2/2] Add symlink. --- README.md | 1 + 1 file changed, 1 insertion(+) create mode 120000 README.md diff --git a/README.md b/README.md new file mode 120000 index 0000000..9d781f1 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +prep/README.md \ No newline at end of file