Project

lolcommits-slack

0.0
No release in over 3 years
Low commit activity in last 3 years
lolcommits-slacklolcommits/lolcommits-slackHomepageDocumentationSource CodeBug Tracker
Automatically post your lolcommits to Slack
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
19,936
Stars
11
Forks
1
Watchers
6
 Releases
Current version
0.5.0
Total releases
10
First release
2017-08-28
Latest release
2020-01-24
 Issues
Open Issues
1
Closed Issues
2
Total Issues
3
Issue Closure Rate
66%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
3
Merged Pull Requests
2
Pull Request Acceptance Rate
40%
 Development
Primary Language
Ruby
Licenses
LGPL-3.0
Average date of last 50 commits
2018-07-04
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
minitest
>= 0
rake
>= 0
simplecov
>= 0
webmock
>= 0

Runtime

lolcommits
>= 0.14.2
rest-client
>= 2.1.0
 Project Readme

Lolcommits Slack

Gem Travis Depfu Maintainability Test Coverage

lolcommits takes a snapshot with your webcam every time you git commit code, and archives a lolcat style image with it. Git blame has never been so much fun!

This plugin automatically posts your lolcommits to one (or more) Slack channels.

The Slack post will contain the git commit message and repo name. The SHA is used as the uploaded file name. Posting will be retried (once) should any error occur.

Requirements

Installation

Follow the install guide for lolcommits first. Then run the following:

$ gem install lolcommits-slack

Configuration

Next configure and enable with:

$ lolcommits --config -p slack
# set enabled to `true`
# enter your access token and Slack channel ID list (see below)

That's it! Every lolcommit will now be posted to these Slack channels. To disable simply reconfigure with enabled: false.

Access Token

This plugin uses Slack legacy tokens for authentication. Create (or grab) them here.

Channel List

You must supply one or more Slack channel IDs. You can use Slack's own API testing tool to list all Slack channels in your account, and grab the IDs from the JSON response presented.

Development

Check out this repo and run bin/setup, this will install dependencies and generate docs. Run bundle exec rake to run all tests and generate a coverage report.

You can also run bin/console for an interactive prompt that will allow you to experiment with the gem code.

Tests

MiniTest is used for testing. Run the test suite with:

$ rake test

Docs

Generate docs for this gem with:

$ rake rdoc

Troubles?

If you think something is broken or missing, please raise a new issue. Take a moment to check it hasn't been raised in the past (and possibly closed).

TODO

  • Use new Oauth / App (instead of legacy tokens)
  • Query for channel list and let user select

Contributing

Bug reports and pull requests are welcome on GitHub.

When submitting pull requests, remember to add tests covering any new behaviour, and ensure all tests are passing on Travis CI. Read the contributing guidelines for more details.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. See here for more details.

License

The gem is available as open source under the terms of LGPL-3.

Links