Git Product home page Git Product logo

cl-prj-notify's Introduction

Tool to send notifications to Common Lisp projects.

Motivation

When cl-test-grid detects regressions in some library, we want to inform the library maintainers. Informing the maintainers takes lot of manual work: google for the library home page, learn where its issue tracker or maling list is, send the message.

As we constantly detect regressions in many libraries we want to authomate this.

Also, other CL community members have similar needs.

It looks like we need two types of notifications:

  • open bugs in issue trackers when we want library authros to take some action.
  • just a notification message, maybe to mailing list or author email.

We envision a function called like this:

(notify-project :prj-name "some-project"
                :type :bug ;; or :message
                :title "regressions on quicklisp 2013-12-13"
                :body "Hello.

some-project has regressions on quicklisp 2013-12-13.

See some-projects test results from the last two quickisp versions:
http://common-lisp.net/project/cl-test-grid/library/some-project.html")

If possible, returns a reference to the notification submitted to the project. Something like (:launchpad-ticket 995657) for launchpad tickets, or (:github-issue :user "avodonosov" :repo "test" :number 160) for github issues, or (mail-archive "http://some/archive/item.html") or just an URI "http://some/message.html".

If it's not possible to return a reference, returns t.

Signals an error in case of problems.

Status

Half of CL projects in Quicklisp are hosted on GitHub.

The function notify-project supports :bug notifications for these projects.

Usage

You need a GitHub Personal Access Token to submit issues. Create one at https://github.com/settings/applications

(pushnew "pats/to/cl-prj-notify/"
         asdf:*central-registry* :test #'equal)

(ql:quickload :cl-prj-notify)
(setf cl-prj-notify:*github-personal-token* "your-github-token-00000000000")

(cl-prj-notify:notify-project :prj-name "project-name"
                              :type :bug
                              :title "unexpected error"
                              :body
                              "Hello.
bla-bla-bla
bla-bla-bla")

cl-prj-notify's People

Contributors

avodonosov avatar

Stargazers

muyinliu avatar  avatar

Watchers

 avatar James Cloos avatar  avatar

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.