https://github.com/opensuse/gitarro

run all your test against a GitHub Pull request
https://github.com/opensuse/gitarro

auto automation ci continuous-integration git github gundam-image jenkins octokit pull-requests ruby testing

Last synced: 2 months ago
JSON representation

run all your test against a GitHub Pull request

• Host: GitHub
• URL: https://github.com/opensuse/gitarro
• Owner: openSUSE
• License: mit
• Created: 2017-08-09T11:45:05.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-26T11:22:35.000Z (over 1 year ago)
• Last Synced: 2024-04-22T13:33:07.383Z (8 months ago)
• Topics: auto, automation, ci, continuous-integration, git, github, gundam-image, jenkins, octokit, pull-requests, ruby, testing
• Language: Ruby
• Homepage: https://opensuse.github.io/gitarro
• Size: 429 KB
• Stars: 15
• Watchers: 8
• Forks: 20
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
 


[![Build Status Master branch](https://travis-ci.org/openSUSE/gitarro.svg?branch=master)](https://travis-ci.org/openSUSE/gitarro)

[![Gem Version](https://badge.fury.io/rb/gitarro.svg)](https://badge.fury.io/rb/gitarro)

![awesome-badge](assets/images/badge.svg)

## Table of Content

- [Introduction](#introduction)

- [Install](#install)

- [Quickstart](#quickstart)

- [Basic concepts, installation, configuration, tests, syntax and a basic example](doc/BASICS.md)

- [Advanced usage](doc/ADVANCED.md)

- [How to contribute to gitarro development](doc/CONTRIBUTING.md)

- [Releasing gitarro](doc/RELEASING.md)

## Introduction

gitarro allow you to run tests on Git Hub [Pull Requests](https://help.github.com/articles/about-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](https://github.com/octokit/octokit.rb).

## Install

`gem install gitarro`

## Quickstart

1. Setup the netrc file

    ```shell

    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

    ```

2. Create a test script for running against PRs

    ```shell

    echo "#! /bin/bash" > /tmp/tests.sh

    echo "exit 0" > /tmp/tests.sh

    chmod +x /tmp/tests.sh

    ```

3. Run gitarro against your GitHub project.

    ```shell

    YOUR_GITHUB_PROJECT="MalloZup/gitarro"

    gitarro.rb -r $YOUR_GITHUB_PROJECT -c "ruby-test" -t /tmp/tests.sh --https

    ```

## Authors

- [Dario Maiocchi](https://github.com/MalloZup)

 Contributor and Maintainers:

 

 - @juliogonzalez

 - @srbarrios

 - @MalloZup

See also the list of [contributors](https://github.com/openSUSE/gitarro/graphs/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](http://awesome-ruby.com)