https://github.com/scality/bert-e

ci git platform-engineering

Last synced: about 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/scality/bert-e
Owner: scality
License: apache-2.0
Created: 2020-07-29T12:59:19.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2025-03-24T17:59:12.000Z (over 1 year ago)
Last Synced: 2025-04-01T17:53:37.014Z (about 1 year ago)
Topics: ci, git, platform-engineering
Language: Python
Homepage:
Size: 1.68 MB
Stars: 1
Watchers: 39
Forks: 1
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
- Codeowners: CODEOWNERS

README

# README

[![codecov](https://codecov.io/gh/scality/bert-e/graph/badge.svg?token=VWEQLKMUN5)](https://codecov.io/gh/scality/bert-e)

Scality's automated branch merging tool.

## User documentation

User documentation can be found [here](./bert_e/docs/USER_DOC.md)

## API documentation

API documentation can be found [here](./bert_e/docs/API_DOC.md)

## Develop on Bert-E

A codespace environment has been setup to develop on Bert-E.
It is the only supported method to develop on Bert-E.

All above instructions will assume you are inside the codespace environment

### Run the bot locally

```shell
$ cp settings.sample.yml settings.yml
# Configure settings.yml to your liking
$ tox run -e run
```

### Run local tests

A series of test scenario will be executed locally using mocks.

```shell
$ tox -e tests
```

### Run tests against githost

This step will run the same tests as above but instead
of using mocks to interact with a githost, it will interact
with the one you have configured.

Credentials are required to run this step, checkout [`tox.ini`](./tox.ini)
file for more details about which credentials are required.

### Extra commands

Checkout the [`tox.ini`](./tox.ini) for all available commands to develop with
bert-e.