A utility to check if a particular file/directory has been effected within a range of commits. Useful for monorepos to check sub-repositories.
Is Effected operates upon a range of Git commits in the repositories' history.
To specify the range of commits you can use either the --from-commit-hash <commit-hash> or --from-reference <reference> arguments.
The range of commits starts exclusively from the commit specified till inclusively of HEAD.
The from arguments can not be used together but one is required.
Over the range of commits you can either specify all the effected resources to be listed out via the --list argument.
Otherwise you can provide regexes via the --effects <resource> argument and if any of the effected resources within the range of commits match, then Is Effected return a zero status code otherwise it return a non-zero status code.
Either of these output arguments are required and can not be used together.
When looking for a repository the Git environment variables are respected.
When $GIT_DIR is set, it takes precedence and Is Effected begins searching for a repository in the directory specified in $GIT_DIR.
When $GIT_DIR is not set, Is Effected searches for a repository beginning in the current directory.
The crates pretty_env_logger and log are used to provide logging.
The environment variable RUST_LOG can be used to set the logging level.
See https://crates.io/crates/prettyenvlogger for more detailed documentation.
Statically linked compiled binaries are available for download. Visit the releases page at https://gitlab.com/DeveloperC/is_effected/-/releases to see all the releases, the release notes contains links to binary downloads for various architectures.
If you do not trust the provided binaries another option is to compile your own and then make it available for remote download, so your CICD etc can then download it.
Checkout the code repository locally, change into the repository's directory and then build via Cargo.
Using the --release flag produces an optimised binary but takes longer to compile.
git clone git@gitlab.com:DeveloperC/is_effected.git
cd is_effected/
cargo build --release
The compiled binary is present at target/release/is_effected.
Cargo is the Rust package manager, the install sub-command pulls from crates.io and then compiles the binary locally, placing the compiled binary at $HOME/.cargo/bin/is_effected.
cargo install is_effected
By default it installs the latest version at the time of execution.
You can specify a specific version to install using the --version argument.
For certain environments such as CICD etc you may want to pin the version.
e.g.
cargo install is_effected --version 0.2.0
Rather than pinning to a specific version you can specify the major or minor version.
e.g.
cargo install is_effected --version ^0
Will download the latest 0.* release whether that is 0.2.2 or 0.7.0.
The unit test suite has several parameterised tests, Cargo is used to set up and run all the unit tests.
cargo test
To report an issue or request a new feature use https://gitlab.com/DeveloperC/is_effected/-/issues.