A bot for code monitoring and more
Hi, I'm alice, made with ❤️ for spreading love among teams (i.e. developers, qa can be friends. O yes! it is possible having me)
I can be your assistant who monitors flow of the code in order to prevent mistakes in your Software Development Life Cycle.
This repository provides a library that's distributed by pip that you can use for building your own inhouse robot mate.
In most cases, you'll probably never have to hack on this repo directly. But if you do, check out CONTRIBUTING.md
I help teams "preventing last moment panic moments" by:
- monitoring/reminding/blocking/alerting teams/individuals to maintain code hygiene
- enabling every member in team to get any info about the system @ any time
- enabling saving some brains whose most of the work time goes in answering same questions about the system
- having a trustworthy 24x7 code monitoring system from dev to release phase which can prevent & alert for any unhealthy action for the code
For all sensitive branches (Ex. master, qa, develop)
- Tech Review
- Comment branch specific guidelines
- Remind release guideline on merge
- Auto close dangerous Pull Request
- Alert for sensitive file(s) modified
- Notify channel on merge
- Notify lead on given action
- Your own Check Implementer
-
Installation:
pip install alice-core -
Getting Started:
2.1 Create your team specific input config file setup config file
2.2. Start Alice (any 1 way):
Modify the commands with particular config.yaml or config.json file path & port number
-
run as uwsgi process
export config="config.yaml"; uwsgi --socket 0.0.0.0:5005 --protocol=http -w alice --callable app -
run as flask app
export FLASK_APP=alice config='config.yaml'; flask run --host 0.0.0.0 --port 5005Note: can change port number as needed
2.3 Plug it in with your system
-
test locally with any pull request payload:
http://0.0.0.0:<GIVE_PORT_NO>it should return "welcome" message
-
activate on your github Create web-hook in github and set it to <IP_WHERE_ALICE_IS_LISTNING>/alice
Example:
-
-
Want to talk to me as well
- integrate me with hubot
Yay! all set. let's rock
Please read CONTRIBUTING.md before submitting your pull requests. If you'd like to chat, drop by joinalice on slack channel
-
More Features
- Notify QA signOff
- Notify Code Freeze
-
Continuous Integration
- Hitesh Mantrala
- Akshay Goel
- Satya
- Jenkins Community
- GitHub Api docs
- Slack Api docs
- Hubot community