Skip to content

👽 Ci-alarm is a Slack bot to help you to communicate with Travis CI

License

Notifications You must be signed in to change notification settings

eromano/ci-alarm

Repository files navigation

Ci Alarm

ci alarm logo

travis Status appveyor status Coverage Status license

issue stats blog unicorn

About Ci-alarm

Ci-alarm is a node.js slack bot to help you to communicate with Travis CI.

With this bot you can :

  • Get in yor slack chat all the info about your Travis Ci and repositories
  • Restart Build
  • Turn on a light alarm through GPIO of the Raspberry Pi when your Travis build fail

Getting Started

  1. Create a new bot integration
  2. Choose between One-Click Heroku or Manual Heroku
  • One-Click Heroku Click this button:

    [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
    
  • Manual Heroku

    • Install Heroku toolbelt
    • Create a new bot integration (as above)
    • heroku create
    • heroku config:set TOKEN_SLACK=[Your Slack bot integration token (obtainable at https://my.slack.com/services/new/bot)]
    • heroku config:set TOKEN_GITHUB=[Your Git hub private token bot integration token (obtainable at https://github.com/settings/tokens) scope needed repo and user]
    • heroku config:set TOKEN_TRAVIS=[Your Travis token (obtainable at https://travis-ci.org/profile/{your_username})]
    • git push heroku master
  1. Have fun Once the bot is running see the documentation for the Command list

Command list

  • To show the command list

    @BotName command list or @BotName help

  • To show the repository status

    @BotName status "[repository name|repository slugName]"

  • To show the repository list

    @BotName repository list

  • To run a build a project on Travis

    @BotName build "[repository name|repository slugName]"

  • To view the build history of a project

    @BotName history "[repository name|repository slugName]"

  • To view info about a project

    @BotName info "[repository name|repository slugName]"

  • To view the status about all your repository

    @BotName report

  • To switch on/off the alarm light if you install ci-alarm on a raspberry pi

    @BotName alarm on/off

Plug-In

Ci Alarm is also able to turn on/off a alarm light when the build is failing. In order to have this kind of plug-in you have to install ci-alarm on a Raspberry PI. All the specification for this kind of configuration are [here](https://github.com/eromano/ci-alarm/blob/master/doc/README.md).
<div align="left"  width="20%" >
  <img title="ci alarm light alarm schema components" src='doc/img/raspberry-pi-logo.png' width="70px" height="80px"  />
</div>

Development

  • To test ci-alarm

    $ npm run-script test

  • To debug ci-alarm

    $ npm run-script debug

  • To see the test coverage ci-alarm

    $ npm run-script coverage

  • To run ci-alarm on your machine

    $ npm run-script start

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b ci-alarm
  3. Commit your changes: git commit -a
  4. Push to the branch: git push origin ci-alarm
  5. Submit a pull request

History

For detailed changelog, check Releases.

Contributors

Contributor GitHub profile Twitter profile
Eugenio Romano (Creator) eromano @RomanoEugenio

About

👽 Ci-alarm is a Slack bot to help you to communicate with Travis CI

Resources

License

Stars

Watchers

Forks

Packages

No packages published