lazylead

Versions Gem Version Downloads Commit activity Hits-of-Code License: MIT

Build status circleci 0pdd Dependency Status Quality Gate Status codebeat badge Codacy Badge Maintainability codecov

DevOps By Rultor.com EO badge

⚠️ We’re still in a very early alpha version, the API may change frequently until we release version 1.0.

Overview

Ticketing systems (Github, Jira, etc.) are strongly integrated into our processes and everyone understands their necessity. As soon as a developer becomes a lead/technical manager, he or she faces a set of routine tasks that are related to ticketing work. On large projects this becomes a problem, more and more you spend time running around on dashboards and tickets, looking for incorrect deviations in tickets and performing routine tasks instead of solving technical problems.

The idea of automatic management is not new, for example Zerocracy is available on the market. I like this idea, but large companies/projects are not ready yet for such a decisive breakthrough and need step-by-step solutions such as lazylead. I think you remember how static code analysis treated at in the past; today we have a huge toolkit (pmd, checkstyle, qulice, rubocop, peon, etc) for each language that allows you to avoid routine issues and remove from the code reviewer the unnecessary load.

Join our telegram group lazylead.org for discussions.

Daily annoying task Jira Github Trello
Notify ticket’s assignee
Notify ticket’s reporter
Notify ticket’s manager
Notify about illegal “Fix Version” modification
Expected comment in ticket is missing
Propagate some fields from parent ticket into sub-tasks
Evaluate the ticket formatting accuracy
Print the current capacity of team into newly created tasks
Create/retrofit the defect automatically into latest release
Notify about expired(ing) due dates
Notify about absent original estimations
Notify about ‘Hot potato’ tickets
Notify about long live tickets (aging)
Notify about tickets with invalid format (missing url/stacktrace, etc)
Create a meeting(s) automatically in case some tickets appeared (group by assignee/reporters/component/ticket type/etc)
Integration Type Status
Microsoft Exchange Server Emails
Microsoft Exchange Server Calendar
mail.yandex.com Emails
mail.google.com Emails 🌵
calendar.google.com Calendar
slack.com Notifications

✅ - implemented, ⌛ - planned, 🌵 - implemented, but not tested, ❌ - not supported by ticketing system.

New ideas, bugs, suggestions or questions are welcome via GitHub issues!

Get started

⚠️ We’re still in a very early alpha version, the API may change frequently until we release version 1.0.

Let’s assume that:

For simplicity, we are using docker-compose:

  1. Define yml file with configuration tasks.yml
    version: '2.3'
    services:
        
      lazylead:
        image: dgroup/lazylead:latest
        container_name: lazylead
        mem_limit: 128m
        environment:
          # The jira server details.
          # Please ensure that your jira filter(s) grants this user to see issues.
          # Sometimes jira filter(s) may be created with restricted visibility, thus
          #  lazylead can't find the issues. 
          jira_url: https://your.jira.com
          jira_user: theuser
          jira_password: thepass
          # The MS Exchange server details, please ensure that '/ews/Exchange.asm` 
          #  will be after your server url. Just change the url to your server.
          exchange_url: https://your.ms.exchange.server/ews/Exchange.asmx
          exchange_user: theuser
          exchange_password: the password
        volumes:
          - ./:/lazylead/db
        # db/ll.db is sqlite file with jira related annoying tasks
        entrypoint: bin/lazylead --sqlite db/ll.db --trace --verbose
    

    or just download the project using git

    git clone https://github.com/dgroup/lazylead.git ll && cd ll
    
  2. Create a container, using docker-compose -f .github/tasks.yml up The container will stop as there were no tasks provided:
    ll > docker-compose -f .github/tasks.yml up                                                         
    Creating lazylead ... done
    Attaching to lazylead
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Version: 0.5.0
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at start is 52MB
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database connection established
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] SMTP connection established with {host} as {user}.
    lazylead    | [2020-08-09T06:17:32] WARN  [main] ll-001: No tasks found.
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at the end is 67MB
    lazylead exited with code 0
    ll > 
    
  3. Define your team and tasks in database. Yes, there are no UI yet, but its planned. Pull requests are welcome! The tables structure defined here. Modify you sqlite file(ll.db) using DB Browser or any similar tool. Please change the <youremail.com> to your email address in order to be in CC when developer get the notification:
    insert into teams (id, name, properties) 
               values (1, 'Dream team with lazylead', '{}');
    insert into systems(id, properties)    
               values (1,'{"type":"Lazylead::Jira", "username":"${jira_user}", "password":"${jira_password}", "site":"${jira_url}", "context_path":""}');
    insert into tasks  (name, schedule, enabled, id, system, team_id, action, properties)
               values ('Expired due dates', 
                       'cron:0 8 * * 1-5', 
                       'true',
                       1, 1, 1, 
                       'Lazylead::Task::AssigneeAlert',
                       '{"sql":"filter=555", "cc":"<youremail.com>", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}');
        
    

    Yes, for task scheduling we are using cron here, but you may use other scheduling types from rufus-scheduler.

  4. Once you changed ./ll.db, please restart the container using docker-compose -f .github/tasks.yml restart
    ll > docker-compose -f .github/tasks.yml restart
    Restarting lazylead ... done
    

    check the logs and stop container if needed

    ll > docker logs lazylead
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Version: 0.5.0
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Memory footprint at start is 52MB
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database: '/lazylead/db/ll.db', sql migration dir: '/lazylead/upgrades/sqlite'
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Migration applied to /lazylead/db/ll.db from /lazylead/upgrades/sqlite
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Database connection established
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] SMTP connection established with {host} as {user}.
    lazylead    | [2020-08-09T06:17:32] DEBUG [main] Task scheduled: id='1', name='Expired due dates', cron='0 8 * * 1-5', system='1', action='Lazylead::Task::AssigneeAlert', team_id='1', description='', enabled='true', properties='{"sql":"filter=555", "cc":"my.email@google.com", "subject":"[LL] Expired due dates", "template":"lib/messages/due_date_expired.erb", "postman":"Lazylead::Exchange"}'
    ...
    

How to contribute?

EO badge

Pull requests are welcome! Don’t forget to add your name to contribution section and run this, beforehand:

bundle exec rake

Everyone interacting in this project’s codebases, issue trackers, chat rooms is expected to follow the code of conduct.

Contributors: