Documentation index

Using Env Variable in your script

Gitarro adds some meta-information about the PR your are testing, and these are passed as environment variables. The variable currently are:

GITARRO_PR_AUTHOR
GITARRO_PR_TITLE
GITARRO_PR_NUMBER
GITARRO_PR_TARGET_REPO

In the script that you are using with the -t option, you can use them , reading the environment variables.

Here just an example:

 do_stuff if ENV['GITARRO_PR_AUTHOR'] == 'MalloZup'
 puts ENV['GITARRO_PR_TITLE']
 puts ENV['GITARRO_PR_NUMBER']
 puts ENV['GITARRO_PR_TARGET_REPO']

Retriggering a specific test

Instructions

In order to retrigger a specific test, you need to add a comment to the PR or add a checkbox into the description of the PR.

PLESE NOTE: gitarro will delete the comment where you write the retriggering command, so make sure that you use a separate comment for this.

Syntax

Using a comment

gitarro rerun <test_name> !!!

Notice that there is a space and three exclamation marks (!!!) after the test name. This is required for the command to work.

Examples

In this examples you want to rerun a test called gitarro-magic.

Valid examples:

• gitarro rerun gitarro-magic !!!

  It will work since there is a space and at least three exclamation marks after the test name.

• gitarro rerun gitarro-magic !!!!!!!

  It will work since there is a space and at least three exclamation marks after the test name.

• I discovered a bug so I need to run tests again, gitarro rerun gitarro-magic !!!!!!!

  It will work since there is a space and at least three exclamation marks after the test name, but the whole comment will be removed and the developer will loose it.

Invalid examples:

• gitarro rerun gitarro-magic !

  It will not work since there is a space after the test name, but less than three exclamation marks.

• gitarro rerun gitarro-magic2 !!!!!!!

  It will not work since there is a space and at least three exclamation marks after the test name, but the test name itself is incorrect.

Using a checkbox

- [x] Re-run test "<test_name>"

Examples

In this examples you want to rerun a test called gitarro-magic.

Valid examples:

• - [x] Re-run test "gitarro-magic"

  It will trigger the test and uncheck automatically, even if the test fails

• - [x] Re-run test "gitarro-magic" (I discovered a bug so I need to run tests again)

  It will work since since is matching the regular expression

Invalid examples:

• - [x] Re-run test gitarro-magic

  It will not work since is not matching the regular expression

Check for PRs

This is useful if you are not using GitHub webhooks but polling the repository.

In this case you do not want to have a history with jobs that did not run tests for PRs, so you could have two jobs, one checking for PRs (without history) calling another that it actually only runs when there is something to check.

For the first you would run gitarro with exactly the same syntax, but adding the paramenter -C or --check what will only check if there are PRs requiring tests. If there is any, it will return 1 to the system, so you can use it to trigger the next job.

Example

Following our basic example, you will run gitarro as follows:

gitarro.rb -r openSUSE/gitarro -c "ruby-test" -d "ruby-gitarro-tuto" -t /tmp/tests.sh -f ".rb" -C

Documentation index