https://github.com/ldez/stackoverflow-slack-bot

Track a tag on StackOverflow and push to Slack
https://github.com/ldez/stackoverflow-slack-bot

slack-bot stackoverflow

Last synced: 6 months ago
JSON representation

Track a tag on StackOverflow and push to Slack

• Host: GitHub
• URL: https://github.com/ldez/stackoverflow-slack-bot
• Owner: ldez
• License: mit
• Created: 2017-05-01T18:01:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-03-15T20:49:17.000Z (almost 7 years ago)
• Last Synced: 2025-05-06T16:14:37.892Z (9 months ago)
• Topics: slack-bot, stackoverflow
• Language: JavaScript
• Size: 26.4 KB
• Stars: 17
• Watchers: 2
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: readme.adoc
  • License: LICENSE.md

Awesome Lists containing this project

README

          
ifdef::env-github[]

:status:

:outfilesuffix: .adoc

:caution-caption: :fire:

:important-caption: :exclamation:

:note-caption: :paperclip:

:tip-caption: :bulb:

:warning-caption: :warning:

endif::[]

= StackOverflow Slack Integration

image:https://travis-ci.org/ldez/stackoverflow-slack-bot.svg?branch=master["Build Status", link="https://travis-ci.org/ldez/stackoverflow-slack-bot"]

image:https://img.shields.io/docker/build/ldez/stackoverflow-slack-bot.svg["Docker Build Status", link="https://hub.docker.com/r/ldez/stackoverflow-slack-bot/builds/"]

This is a basic script to keep track a tag on StackOverflow and push accurate links to Slack.

image::https://cloud.githubusercontent.com/assets/5674651/25589901/a3124e4a-2eae-11e7-838c-13c80c69d2f8.png[slackoverbot]

== How to use

- Make sure link:https://nodejs.org[Node] is installed.

- Run `npm install`.

- Add your configuration to `config.json`

- Let a cron-job run `npm run start` every 15 minutes (StackOverflow quota is 300 requests by day)

.config.json

[source, json]

----

{

  "tags": "tag1;tag2",

  "so": {

    "apiBaseURL": "https://api.stackexchange.com/2.2",

    "key": "[optional: your StackApps key, for a higher request quota]",

    "dayBack": 1,

    "hourBack": 0,

    "minuteBack": 0

  },

  "slack": {

    "apiBaseUrl": "https://[your_team_name].slack.com/api/",

    "token": "[your_token]",

    "channel": "#random",

    "botName": "[your_bot_name]",

    "botIcon": "[your_bot_icon]",

    "icons": {

      "newActivity": ":trackball:",

      "topic": ":speaking_head_in_silhouette:",

      "askedQuestion": ":speech_balloon:",

      "revisedQuestion": ":pencil:",

      "revisedAnswer": ":pencil:",

      "answerAccepted": ":ok_hand:",

      "postedAnswer": ":left_speech_bubble:",

      "comment": ":grey_question:"

    }

  },

  "lastEndFileName": "lastend",

  "dryRun": false

}

----

// [horizontal]

tags:: name of the tags to track (separate by `;`),

so.apiBaseURL:: URL of the StackOverflow API.

so.minuteBack:: number of minutes previous now, use for create the first query.

so.hourBack:: number of hours previous now, use for create the first query.

so.dayBack:: number of days previous now, use for create the first query.

so.key:: an API key from https://stackapps.com/apps/oauth/register/submit to increase your per-day quota from 300 to 10000

slack.apiBaseUrl:: URL of Slack API.

slack.token:: Slack token, only for dev purpose. DON'T USE IN PRODUCTION.

slack.channel:: Name of the channel to publish. (must start with `#`)

slack.botName:: your bot account name.

slack.botIcon:: your bot emoji icon. (can be blank.)

slack.icons.xxx:: emoji for each situation. (can be blank.)

lastEndFileName:: name of file use for store the last query date.

dryRun:: if `true`, display the Slack payload without send it.

IMPORTANT: In production, use environment variable to set your Slack token (`SLACK_API_TOKEN`).

Thanks to link:https://github.com/cwi-swat[@cwi-swat] for link:https://github.com/cwi-swat/stackoverflow-slack-plugin[inspiration].