bel
belay
cargo install belay
bel

belay

Run your CI checks locally to `git push` with confidence

by Josh Mcguigan

0.5.0 (see all)License:MIT/Apache-2.0
cargo install belay
Readme

Belay crates.io badge github action badge

Belay makes it easy to run your CI checks locally, so you can git push with confidence.

asciicast

Usage

In a git repo with either Gitlab or GitHub CI configured, running belay with no arguments will parse your CI configuration and run your CI scripts on your local machine.

$ belay
Checking 'build':
Success!
Checking 'test':
... test output
..
.
Success!

Belay can also setup pre-commit or pre-push git hooks in your repo.

# to create a pre-push hook
$ belay hook push

# to create a pre-commit hook
$ belay hook commit

Install

cargo install --force belay

Configuration

Belay creates a configuration file in the following location:

  • Linux: /home/alice/.config/belay/config.yml
  • Windows: C:\Users\Alice\AppData\Roaming\cargo\belay\config.yml
  • macOS: /Users/Alice/Library/Preferences/com.cargo.belay/config.yml

The keys of the config file are described below:

  • command_blacklist
    • array of strings
    • belay will skip CI tasks which contain any string in the command blacklist

License

Licensed under either of

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.

GitHub Stars

40

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

1

OPEN PRs

0
VersionTagPublished
0.5.0
2yrs ago
0.4.0
2yrs ago
0.3.0
2yrs ago
0.2.0
2yrs ago
No alternatives found
No tutorials found
Add a tutorial