Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxking/mailmania-bot
Gitlab Bot to backport merge requests to stable release branches.
https://github.com/maxking/mailmania-bot
automation aws aws-apigateway aws-lambda backport bot chalice cloud git-tools git-workflow gitlab python python3 python36 serverless serverless-examples tools-engineering
Last synced: 12 days ago
JSON representation
Gitlab Bot to backport merge requests to stable release branches.
- Host: GitHub
- URL: https://github.com/maxking/mailmania-bot
- Owner: maxking
- License: apache-2.0
- Created: 2017-10-26T00:36:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-30T19:19:01.000Z (over 7 years ago)
- Last Synced: 2024-11-19T19:24:09.485Z (2 months ago)
- Topics: automation, aws, aws-apigateway, aws-lambda, backport, bot, chalice, cloud, git-tools, git-workflow, gitlab, python, python3, python36, serverless, serverless-examples, tools-engineering
- Language: Python
- Size: 71.3 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mailmania Bot
[](https://travis-ci.org/maxking/mailmania-bot) [](https://codecov.io/gh/maxking/mailmania-bot) [](https://codeclimate.com/github/maxking/mailmania-bot/maintainability)
This bot is meant to help with backporting merge requests to branches other than
'master'. It is built using server application framework [Chalice][3] hosted on
[AWS Lambda][1] and receives notifications using [Gitlab's Webhooks][2].
**Note** : This is a alpha quality software and is under active development.
**Please use it at your own risk.**
## Setup
This bot is not specific to any project and (minus some bugs) can be run for any
project on Gitlab.com. In future, I am planning to add support for
non-Gitlab.com instances of Gitlab and Github too, but there is not ETA. If
you'd like to help, please feel free to send in a pull request.
If you are not familiar with Chalice, I recommend that you look through its
[documentation][4] to make sure you understand what are you doing. You need to
[setup AWS credentials][5] on your local machine to be able to deploy to AWS Lambda
using Chalice.
### Chalice Configuration
Then, go ahead and clone this repo:
```bash
$ git clone https://github.com/maxking/mailmania-bot.git
```
Create a new configuration file at `mailmania-bot/.chalice/config.json`:
```json
{
"version": "2.0",
"app_name": "mailmania",
"environment_variables": {"_GL_TOKEN": "",
"GITLAB_TOKEN": "",
"BACKPORT_DESTINATION": "",
"ADMIN_EMAIL": "[email protected]"},
"stages": {
"dev": {
"api_gateway_stage": "api"
}
}
}
```
The environment variables in above configuration are meant to pass credentials
to the Lambda Function as environment variables:
- `_GL_TOKEN` : This is a secret token you set in Gitlab when
creating the Webhook to make sure your bot doesn't serve random web requests
from un-intended users. Please replace `` with the name of your
project without the namespace. So for https://gitlab.com/maxking/mailman you
will set `MAILMAN_GL_TOKEN`.
- `GITLAB_TOKEN`: This is the [personal access token][6] for your Gitlab User
which has enough permissions to create branches in the project that webhook in
set for. Merge requests will be created by this user.
- `BACKPORT_DESTINATION`: For now, this bot can only backport to a single branch
whose name is set as the value of this environment variable. Merge Requests
with label "backport-candidate" only are processed by this bot.
- `ADMIN_EMAIL`: In case anything goes wrong, an email will be sent to this
email address with error trace. Currently, this doesn't work properly.
- `DEFAULT_FROM_EMAIL`: The From address to send emails from.
### Deploying
Deployment step for this bot:
1. Create a virtual environment using Python 3.6:
```bash
$ virtualenv -p python3.6 aws-chalice
$ aws-chalice/bin/activate
```
2. Install chalice and dependencies in your virtual environment:
```bash
$ pip install chalice
$ pip install -r requirements.txt
```
3. Deploy to AWS lambda:
```bash
$ chalice deploy
```
The above command should create appropriate policies for AWS IAM (for Lambda
Function), AWS SES (to send emails), AWS API Gateway, setup API gateway
endpoints for your project and push your packaged virtual environment to AWS
Lambda.
The above command will also give you endpoint where your bot will listen for
requests. You will need this in next step to setup the Gitlab's Webhook.
**Note**: Sometimes, you may get `Module 'gitlab' not found` or similar
errors for dependencies. Please de-activate and re-activate your virtualenv
to fix this. I am not sure about the exact reason for this problem.
I recommend reading [Chalice's Quickstart][7] and [documentation][4] for more
detailed instructions.
### Gitlab Setup
Now, you need to add a webhook in your Gitlab project to send a POST to the URL
you received in the previous step after running `chalice deploy` command.
You will also need a long random token which you added in the configuration
above to make sure only requests from Gitlab project are processed by the
Bot. Add this token under "Secret Token" in add web hook form.
Check only "Merge Request events" in the list of events.
Finally, save your webhook.
## Process of creating Merge Request
This is the steps bot does to create a backported merge request:
1. Create a new branch with `BACKPORT_DESTINATION` branch as the reference.
2. Cherry-pick all the commits from the MR being backported.
3. Create a new MR from this new branch to the `BACKPORT_DESTINATION` branch.
## Contributing Guidelines
Contributions and questions are welcome. Please create a issue on the Github
project.
## License
This project is Licensed under Apache License 2.0. Please see the LICENSE file
for full license text.
[1]: https://aws.amazon.com/lambda/
[2]: https://docs.gitlab.com/ee/user/project/integrations/webhooks.html
[3]: https://github.com/aws/chalice
[4]: https://chalice.readthedocs.io/en/latest/index.html
[5]: https://github.com/aws/chalice#credentials
[6]: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
[7]: https://github.com/aws/chalice#quickstart