https://github.com/giansalex/branching-workflow

Keep your Branching Model after Pull Requests
https://github.com/giansalex/branching-workflow

branching-flow github-bot probot

Last synced: about 2 months ago
JSON representation

Keep your Branching Model after Pull Requests

• Host: GitHub
• URL: https://github.com/giansalex/branching-workflow
• Owner: giansalex
• License: isc
• Created: 2018-05-04T19:53:47.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-11T19:08:06.000Z (about 8 years ago)
• Last Synced: 2025-04-06T23:45:00.206Z (about 1 year ago)
• Topics: branching-flow, github-bot, probot
• Language: JavaScript
• Homepage: https://github.com/apps/silvia
• Size: 63.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Branch Workflow - Github Bot

[![Build Status](https://travis-ci.org/giansalex/branching-workflow.svg?branch=master)](https://travis-ci.org/giansalex/branching-workflow)

[![codecov](https://codecov.io/gh/giansalex/branching-workflow/branch/master/graph/badge.svg)](https://codecov.io/gh/giansalex/branching-workflow)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8c1f7e742472499987106c14ef3a8a9b)](https://app.codacy.com/app/giansalex/branching-workflow?utm_source=github.com&utm_medium=referral&utm_content=giansalex/branching-workflow&utm_campaign=badger)

[![Maintainability](https://api.codeclimate.com/v1/badges/0f8d8f506402058c30a9/maintainability)](https://codeclimate.com/github/giansalex/branching-workflow/maintainability)    

Auto Merge and Branch WorkFlow Probot APP.

> A GitHub App built with [probot](https://github.com/probot/probot). 

## Configuration file

Create `.github/branch.yml` and configure your branches.

```yaml

autoMerge:

  - target: EPD

    source: EPD

  - target: QAS

    source: QAS

restrict:

  - target: master

    source:

      - ppr

      - pprfix

    close: true

  - target: ppr

    source: qas

    fork: true

```

Pull Request with title `[WIP]` aren't merged.

## Github App Permissions & Events

**Permissions**

- Repository contents - **Read & write** 

- Repository metadata - **Read-only**

- Pull requests - **Read & write**

- Single File - **Read-only**

  - Path: `.github/branch.yml`

- Commit statuses - **Read & write**

**Events**

- [x] Check the box for **Pull request** events

## Setup

```sh

# Install dependencies

npm install

# Run the bot

npm start

```

## Docker

Using node alpine image.

> You need to have `private.pem` file.

```sh

docker build -t branch-bot .

docker run -d -p 80:3000 -e APP_ID= -e WEBHOOK_SECRET= -e PRIVATE_KEY=$(cat private.pem) --name gitbot branch-bot

```