An open API service indexing awesome lists of open source software.

https://github.com/firstbirdtech/emergence

A bot that automatically merges your pull requests based on configurable conditions.
https://github.com/firstbirdtech/emergence

bitbucket-cloud bot git merge scala

Last synced: 6 months ago
JSON representation

A bot that automatically merges your pull requests based on configurable conditions.

Awesome Lists containing this project

README

          

*This project is no longer maintained in this repository, please check [this fork](https://github.com/fgrutsch/emergence) for future maintenance and development instead.*

# eMERGEnce

[![Maven Central](https://img.shields.io/maven-central/v/com.firstbird.emergence/core_2.13.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.firstbird.emergence%22%20AND%20a:%22core_2.13%22)
[![Github Actions CI Workflow](https://github.com/firstbirdtech/emergence/workflows/CI/badge.svg)](https://github.com/firstbirdtech/emergence/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/firstbirdtech/emergence/branch/master/graph/badge.svg?token=mTUZsPVuXK)](https://codecov.io/gh/firstbirdtech/emergence)
[![Docker Pulls](https://img.shields.io/docker/pulls/firstbird/emergence.svg)](https://img.shields.io/docker/pulls/firstbird/emergence.svg)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

eMERGEnce is a bot that helps you to get rid of all your emerged pull requests automatically based on configurable conditions.

## Documentation

The full documentation can be found [here](https://emergence.fgrutsch.com).

## Quickstart

To install eMERGEnce as an executable you can use coursier's [install](https://get-coursier.io/docs/cli-install) command. The only thing you have to do is to run:

`coursier install --channel http://coursier.fgrutsch.com emergence`

To get a list of available options run: `emergence --help` and you should get the following output:

```
Usage: emergence --config --vcs-type --vcs-api-host --vcs-login --git-ask-pass [--repo-config-name ]

eMERGEnce

Options and flags:
--help
Display this help text.
--version, -v
Print the version number and exit.
--config
The path to the eMERGEnce run config file.
--vcs-type
The type of VCS you want to run eMERGEnce.
--vcs-api-host
The base URI for VCS api calls. e.g. https://api.bitbucket.org/2.0
--vcs-login
The username for authenticating VCS API calls.
--git-ask-pass
The path to the executable script file that returns your VCS secret for authenticating VCS API calls.
--repo-config-name
The name/path of the eMERGEnce config file inside the repository. Default: .emergence.yml
```

An example command might look like this (depending on the selected VCS type):

```bash
emergence \
--config "/opt/emergence/run-config.yml" \
--vcs-type "bitbucket-cloud" \
--vcs-api-host "https://api.bitbucket.org/2.0" \
--vcs-login ${BITBUCKET_USERNAME} \
--git-ask-pass "/opt/emergence/git-ask-pass.sh"
```

For full documentation and how to run it via docker please check the link above.

## Credits

The code of this project is heavily inspired and based on [fthomas's](https://github.com/fthomas) awesome [scala-steward](https://github.com/scala-steward-org/scala-steward) project. Go check it out!

## Contributors

* [Fabian Grutsch](https://github.com/fgrutsch)

## License

This code is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.txt).