# All existing runnables

This section describes each existing runnables: what's its goal and how to use it.

# CommentIssueRunnable

# Goal

CommentIssueRunnable comments the Issue processed by the previous rule.

# Usage

This Post-Action only needs a string message. This string can contain handlebars templating.

To use the CommentIssueRunnable, add the callback on your .rulesrc config file.

# ...
onError:
  - callback: CommentIssueRunnable
    args:
      comment: 'ping @bastienterrier'

# CommentPullRequestRunnable

# Goal

CommentPullRequestRunnable comments the PR or MR processed by the previous rule.

# Usage

This Post-Action only needs a string message. This string can contain handlebars templating.

To use the CommentPullRequestRunnable, add the callback on your .rulesrc config file.

# ...
onError:
  - callback: CommentPullRequestRunnable
    args:
      comment: 'ping @bastienterrier'

# CreateIssueRunnable

# Goal

CreateIssueRunnable create an issue with the specified CreateIssueArgs params.

# Usage

This Post-Action need the following args:

• title: the title of your issue,
• description: the description [optional],
• assignees: an array of users [optional],
• labels: an array of labels [optional],

To use the CreateIssueRunnable, add the callback on your .rulesrc config file.

# ...
onError:
  - callback: CreateIssueRunnable
    args:
      title: 'Add a README'
      description: 'We should create a README.md file to provide project's description to our users.'

# CreatePullRequestRunnable

# Goal

CreatePullRequestRunnable creates a new PR or MR.

# Usage

This Post-Action need the following args:

• title: the title of your PR/MR,
• description: the description [optional],
• source: the source branch [optional],

  master by default.

• target: the target branch [optional].

  current branch return by the data.branch attribute of the previous RuleResult.

To use the CreatePullRequestRunnable, add the callback on your .rulesrc config file.

# ...
onError:
  - callback: CreatePullRequestRunnable
    args:
      title: 'WIP: {{data.branchSplit.1}}'
      description: 'this is the description'

# DeleteBranchRunnable

# Goal

The DeleteBranchRunnable delete a particular branch.

# Usage

This Post-Action has one optionnal arg:

• branchName: the branch to delete [optional].

  If no branch name is provide, it will be set to data.branch returned by the previous rule.

To use the DeleteBranchRunnable, simply add the callback on your .rulesrc config file.

# ...
onError:
  - callback: DeleteBranchRunnable
    args:
      branchName: develop

# DeleteFilesRunnable

# Goal

The DeleteFilesRunnable delete a set of files.

# Usage

This Post-Action need the following args:

• files: the files list to delete or a comma-separated string [optional],
• message: the commit message [optional],

  If not provide, it will be removing file

• branch: the branch on which it will delete the files [optional].

  If no branch name is provide, it will be set to data.branch returned by the previous rule if exist, master otherwise.

To use the DeleteFilesRunnable, simply add the callback on your .rulesrc config file.

# ...
onError:
  - callback: DeleteFilesRunnable
    args:
      message: 'deleting file!'
      branch: master
      files:
        - a.exe
        - b.exe
      # or
      # files: 'a.exe,b.exe'
      #
      # can be chained with `checkAddedFiles`
      # files: '{{#data.addedFiles}}{{.}},{{/data.addedFiles}}

# LoggerRunnable

# Goal

The LoggerRunnable Post-Action, like its name suggest, log informations, using winston logger.

# Usage

This Post-Action need two args:

• type: info|warn|error [optional],

  If you're in an onSuccess or onBoth statement, the default value will be info. On the other hand, if you're in an onError statement, it would be error.

• message: a string that can contain handlebars templating.

To use the LoggerRunnable, simply add the callback on your .rulesrc config file.

# ...
onSuccess:
  - callback: LoggerRunnable
    args:
      type: info
      message: '{{data.issue.title}} is correct issue title'

# MergePullRequestRunnable

# Goal

MergePullRequestRunnable merge the PR or MR processed by the previous rule.

# Usage

This Post-Action need the following args:

• commitTitle: the title of the commit [optional],
• commitMessage: extra commit informations [optional],

  Not available on Gitlab

• sha: sha that pull request head must match to allow merge [optional],
• method: merge|squash|rebase [optional].

  Default method value is merge

  rebase does not exist on Gitlab

To use the MergePullRequestRunnable, simply add the callback on your .rulesrc config file.

# ...
onSuccess:
  - callback: MergePullRequestRunnable
    args:
      commitTitle: 'merging {{data.branch}} PR'
      commitMessage: 'extra informations...'
      sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
      method: squash

# SendEmailRunnable

# Goal

SendEmailRunnable allows you to send Email with the Gmail API.

If you're using Hygie through our API, you do not have any configuration to do.

Otherwise, in case of self-hosted solution, make sure you have followed the getting started section.

# Usage

This Post-Action need the following args:

• to: the email of the addressee,
• subject: the subject of your email,
• message: the content of your email.

To use the SendEmailRunnable, add the callback on your .rulesrc config file.

# ...
onSuccess:
  - callback: SendEmailRunnable
    args:
      to: bastien.terrier@gmail.com
      subject: 'New issue (#{{data.issue.number}}) '
      message: '<b>{{data.issue.title}}</b> has been created!'

# UpdateCommitStatusRunnable

# Goal

UpdateCommitStatusRunnable updates the commits' status processed by the previous rule.

# Usage

This Post-Action need the following args:

• successTargetUrl: the URL to redirect to in case of success,
• failTargetUrl: the URL to redirect to in case of failure,
• successDescriptionMessage: the shown message on success,
• failDescriptionMessage: the shown message on failure.

To use the UpdateCommitStatusRunnable, add the callback on your .rulesrc config file.

# ...
onBoth:
  - callback: UpdateCommitStatusRunnable
    args:
      successTargetUrl: 'https://gist.github.com/stephenparish/9941e89d80e2bc58a153#examples'
      failTargetUrl: 'https://gist.github.com/stephenparish/9941e89d80e2bc58a153#examples'
      successDescriptionMessage: 'Commit message matches the Good Practices!'
      failDescriptionMessage: 'Caution, your commit message do not matches the Good Practices!'

# UpdateIssueRunnable

# Goal

UpdateIssueRunnable update some issue's properties.

# Usage

This Post-Action need the following args:

• labels: the string list of labels [optional],

  Be careful, this will not appened labels to existing one, but overwrite them.

• state: open|close [optional].

To use the UpdateIssueRunnable, simply add the callback on your .rulesrc config file.

# ...
onError:
  - callback: UpdateIssueRunnable
    args:
      labels:
        - good first issue
        - enhancement
      state: open

# UpdatePullRequestRunnable

# Goal

UpdatePullRequestRunnable update some PR's properties.

# Usage

This Post-Action need the following args:

• target: the branch target [optional],
• title: the title of the PR [optional],
• state: open|close [optional],
• description: the PR description [optional].

To use the UpdatePullRequestRunnable, simply add the callback on your .rulesrc config file.

# ...
onError:
  - callback: UpdatePullRequestRunnable
    args:
      target: 'my_target_branch'
      title: 'WIP: add custom rules'
      description: 'some extra informations...'
      state: open

# WebhookRunnable

# Goal

WebhookRunnable sends a POST request to the provided URL with custom data and config.

# Usage

This Post-Action need the following args:

• url: the string url,
• data: the data you want to send (any type) [optional],
• config: the AxiosRequestConfig configuration [optional].

All of these parameters can contain handlebars templating.

To use the WebhookRunnable, simply add the callback on your .rulesrc config file.

# ...
onError:
  - callback : WebhookRunnable
    args:
        url: 'https://webhook.site/0de43177-bcfe-e2f6a2845ce8'
        data: {
            user: 'bastien terrier',
            content: 'More than one commmit !',
            commits: '{{#data.commits}}
                {{message}} (#{{id}})
            {{/data.commits}}
            ',
            }
        config: {
            headers: {
                Authorization: 'token 1234567890abcdef'
            }
        }