Giter VIP home page Giter VIP logo

octonag's Introduction

OctoNag Bot

THIS PROJECT IS ARCHIVED AND NO LONGER MAINTAINED. I am currently working on a re-write of it in Rust, you can find it here -> https://github.com/taliamax/octo_nag

Build Status

Pytest Coverage Status

Quickjump

  1. Onboarding
  2. Configuration
  3. Setup Locally Using Virtual Environment
  4. Setup Locally Using Docker
  5. Setting Up Automation

Onboarding

For a more detailed guide on how to start up and configure your OctoNag instance, look at the onboarding docs

Configuration

  1. Make sure that SLACK_API_TOKEN and GITHUB_API_TOKEN are set as environment variables
  2. (Optional) set JIRA_USER and JIRA_PASS as environment variables to mute notifications for pull requests that can be linked to Jira tickets in states other than REVIEW.
  3. Add organizations & repositories to watch onto your conf/config.yaml file
  4. Add your team members to the whitelist. It is highly recommended that you add your teammates to the whitelist to make sure that if anyone else is also contributing to the repo, they will not get unexpected nags.
  5. If necessary (i.e. when members are on PTO/out sick/should not be nagged), add team members to the blacklist

Setup Locally Using Virtual Environment

Note: This setup guide assumes you have pip, virtualenv, and virtualenvwrapper installed, and are working on a Linux or Mac terminal. As a reminder, the OctoNag runs on Python 3.

  1. Create a new virtual environment:
    # In the octonag directory
    mkvirtualenv octonag -a .
  1. Activate the virtual environment:
    workon octonag
  1. Install the OctoNag
    ./install    # Installs the octonag & the pre-commit hooks

You can now run the OctoNag by using:

    octonag

The OctoNag has pre-commit hooks enabled. This is to ensure that all code that is committed meets a minimum threshold of quality, so that all problems can be caught as early as possible. Currently, this means running flake8.

Setup Locally Using Docker

Note: Requires Docker for Mac or Windows or Ubuntu

The OctoNag comes with the following handy make commands for Docker usage. They can be seen below:

make build      # Builds the image
make run        # Runs the OctoNag
make test       # Runs the OctoNag tests
make teardown   # Deletes the image
make rebuild    # Tears down, then builds the image
make activate   # Tears down image if existing, builds it, runs, then cleans up

octonag's People

Contributors

cryptaliagy avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

hosseinsey

octonag's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.