Table of Content
- Introduction
- Install
- Quickstart
- Basic concepts, installation, configuration, tests, syntax and a basic example
- Advanced usage
- How to contribute to gitarro development
- Releasing gitarro
Introduction
gitarro allow you to run tests on Git Hub Pull Requests (also known as PRs) using almost any script, language or binary and providing easy integration with other tools, and testing env. (such containers, cloud, VMS, etc.)
It can run on any system that is able to use ruby and octokit.
Install
gem install gitarro
Quickstart
-
Setup the netrc file
GITHUB_USER=INSERT GITHUB_PWD_OR_TOKEN=foo echo "machine api.github.com login $GITHUB_USER password $GITHUB_PWD_OR_TOKEN" > ~/.netrc sudo chmod 0600 ~/.netrc
-
Create a test script for running against PRs
echo "#! /bin/bash" > /tmp/tests.sh echo "exit 0" > /tmp/tests.sh chmod +x /tmp/tests.sh
-
Run gitarro against your GitHub project.
YOUR_GITHUB_PROJECT="MalloZup/gitarro" gitarro.rb -r $YOUR_GITHUB_PROJECT -c "ruby-test" -t /tmp/tests.sh --https
Authors
Contributor and Maintainers:
- @juliogonzalez
- @srbarrios
- @MalloZup
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Extra
Gitarro is part of the curate list Awesome Ruby