pkgcruft-git is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing `pkgcruft-git` `pkgcruft-git-pre-commit` `pkgcruft-git-pre-push` `pkgcruft-gitd` executables

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install pkgcruft-git

It will make pkgcruft-git pkgcruft-git-pre-commit pkgcruft-git-pre-push pkgcruft-gitd commands available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall pkgcruft-git uninstalls.

Adding `pkgcruft_git` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add pkgcruft-git

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

pkgcruft-git = "0.0.5"

The pkgcruft_git library will be automatically available globally. Read the pkgcruft_git library documentation.

Back to the crate overview.

Readme

pkgcruft-git

QA support for verifying git commits via pkgcruft.

Install

Build and install from git:

cargo install pkgcruft-git --git https://github.com/pkgcraft/pkgcraft.git

Client side verification via pre-push hook

To perform commit verification locally before pushing to a remote, symlink the pkgcruft-git-pre-push binary as a pre-push hook for the target git repo:

cd path/to/git/repo
mkdir -p .git/hooks
ln -s $(which pkgcruft-git-pre-push) .git/hooks/pre-push

When using multiple pre-push hooks, it will have to be called manually passing the expected remote arguments.

Server side verification via pre-receive hook

To start a service demo, run the following script:

./examples/pkgcruft-gitd

This will build the required pkgcraft tooling and initialize the files necessary to run the service in the examples/demo directory. By default it uses the gentoo repo from github, but should work if pointed at any accessible, remote git URL for a standalone ebuild repo.

The script creates three git repos under the examples/demo directory. The client.git repo is what users should interact with, creating commits and using git push that pushes them to the remote.git repo. The remote repo is configured to trigger pkgcruft scanning runs via a pre-receive hook targeting the changes made in the commits.

Once the repos are set up, the script ends by starting the pkgcruft-gitd service that runs against the server.git repo. The service can be stopped via SIGINT and restarted by re-execing the script.

To reset the demo entirely, recursively remove the examples/demo directory before running the script.

Installing pkgcruft-git pkgcruft-git-pre-commit pkgcruft-git-pre-push pkgcruft-gitd executables

Adding pkgcruft_git library as a dependency

Installing `pkgcruft-git` `pkgcruft-git-pre-commit` `pkgcruft-git-pre-push` `pkgcruft-gitd` executables

Adding `pkgcruft_git` library as a dependency