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

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

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

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

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 .

2. Activate the virtual environment:

    workon octonag

3. 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.

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