https://github.com/prestashop/issuebot

A bot for automating issue status
https://github.com/prestashop/issuebot

probot tool

Last synced: 4 months ago
JSON representation

A bot for automating issue status

• Host: GitHub
• URL: https://github.com/prestashop/issuebot
• Owner: PrestaShop
• License: mit
• Created: 2018-09-03T15:22:41.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-16T00:55:12.000Z (about 1 year ago)
• Last Synced: 2024-10-07T10:58:35.825Z (4 months ago)
• Topics: probot, tool
• Language: JavaScript
• Homepage:
• Size: 1.85 MB
• Stars: 6
• Watchers: 22
• Forks: 8
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Issue Bot

> A GitHub App built with [Probot](https://probot.github.io) to automate PrestaShop project workflow

## Setup

```sh

# Install dependencies

npm install

# Run the bot

npm start

```

If you want to use multiple node versions on your development environment, consider using NVM

[See NVM installation guide](https://github.com/nvm-sh/nvm#install-script)

```shell script

nvm install 12.16.0

nvm use 12.16.0

node --version #will output v12.16.0

```

## Development environment

See Probot doc [for local development](https://probot.github.io/docs/development/) and

[simulating github webhooks](https://probot.github.io/docs/simulating-webhooks/)

## Test

```

npm run test

```

## Deployment

See [Probot doc](https://probot.github.io/docs/deployment/)

## Insights

The entry point is file `index.js`.

In this file, upon receiving a webhook, the bot performs 3 steps:

1) setup the app, setup javascript components

2) analyze incoming github webhook to find whether this matches one of the registered Rules

```

let rulePromise = ruleComputer.findRule(context);

```

3) if the analysis is successfull, apply the rule

```

ruleApplier.applyRule(rule, context);

```

The idea behind is to define a set of Rules for PrestaShop

project workflow and the bot applies them.

Rules are described in `src/rule.js` file.

A config file have been introduced to setup your repositories