All Projects → nodejs → Github Bot

nodejs / Github Bot

Licence: mit
@nodejs-github-bot's heart and soul

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Github Bot

Ruby Telegram Bot Starter Kit
✈️ Ruby Telegram boilerplate for creating awesome bots. Check out best tools from the world of bots - https://github.com/BotCube/awesome-bots
Stars: ✭ 197 (-4.83%)
Mutual labels:  bot
Telegram Rat
Windows Remote Administration Tool via Telegram. Written in Python
Stars: ✭ 201 (-2.9%)
Mutual labels:  bot
Rasa core
Rasa Core is now part of the Rasa repo: An open source machine learning framework to automate text-and voice-based conversations
Stars: ✭ 2,302 (+1012.08%)
Mutual labels:  bot
Aegis.cpp
Discord C++ library for interfacing with the API. Join our server:
Stars: ✭ 198 (-4.35%)
Mutual labels:  bot
Pajbot
Twitch moderation bot
Stars: ✭ 198 (-4.35%)
Mutual labels:  bot
Bas
BrowserAutomationStudio can automate everything that Chrome can.
Stars: ✭ 203 (-1.93%)
Mutual labels:  bot
Node Vk Bot Api
🤖 VK bot framework for Node.js, based on Bots Long Poll API and Callback API.
Stars: ✭ 195 (-5.8%)
Mutual labels:  bot
Chatapi Wechat
Java版本微信聊天接口,使用网页微信API,让你能够开发自己的微信聊天机器人
Stars: ✭ 207 (+0%)
Mutual labels:  bot
Nvidia Sniper
🎯 Autonomously buy Nvidia Founders Edition GPUs as soon as they become available.
Stars: ✭ 193 (-6.76%)
Mutual labels:  bot
Venom
Venom is the most complete javascript library for Whatsapp, 100% Open Source.
Stars: ✭ 3,457 (+1570.05%)
Mutual labels:  bot
Weekly Digest
Weekly summary of activity on your GitHub repository 📆
Stars: ✭ 199 (-3.86%)
Mutual labels:  bot
Hubot Slack
Slack Developer Kit for Hubot
Stars: ✭ 2,260 (+991.79%)
Mutual labels:  bot
Discorddj
Discord DJ Bot. Play music in your server. Inspired by PlugDJ
Stars: ✭ 204 (-1.45%)
Mutual labels:  bot
Whatsapp Assistant Bot
A personal WhatsApp assistant bot that will help you search anything on the web (Google, Images, Google Maps)
Stars: ✭ 198 (-4.35%)
Mutual labels:  bot
Telegram Bot Api
First Telegram Bot API node.js library
Stars: ✭ 205 (-0.97%)
Mutual labels:  bot
Unit Uskit
unit-uskit
Stars: ✭ 197 (-4.83%)
Mutual labels:  bot
Viber Bot Php
Php bot interface to work with Viber API
Stars: ✭ 202 (-2.42%)
Mutual labels:  bot
Farm
Zerocrat Core Engine
Stars: ✭ 207 (+0%)
Mutual labels:  bot
Node Fb Messenger
✉️ Facebook Messenger Platform Node.js API Wrapper
Stars: ✭ 206 (-0.48%)
Mutual labels:  bot
Master Bot
A Discord music bot with playlist support, music quiz, saved playlists, lyrics, gifs and more
Stars: ✭ 204 (-1.45%)
Mutual labels:  bot

Node.js GitHub Bot

The Node.js Foundation members use this bot to help manage the repositories of the GitHub organization.

It executes scripts in response to events that are pushed to it via GitHub webhooks. All repositories that use this bot have the same webhook url & secret configured (there is only 1 bot instance). Org-wide webhooks are not allowed.

Contributing

Please do, contributions are more than welcome! See CONTRIBUTING.md.

Environment Variables

  • GITHUB_TOKEN
    The GitHub API token for your account (or bot account) that will be used to make API calls to GitHub. The account must have proper access to perform the actions required by your script.
  • GITHUB_WEBHOOK_SECRET
    The webhook secret that GitHub signs the POSTed payloads with. This is created when the webhook is defined. The default is hush-hush.
  • JENKINS_WORKER_IPS
    List of valid Jenkins worker IPs allowed to push PR status updates, split by comma: 192.168.1.100,192.168.1.101.
  • JENKINS_API_CREDENTIALS (optional)
    For scripts that communicate with Jenkins on http://ci.nodejs.org. The Jenkins API token is visible on your own profile page https://ci.nodejs.org/user/<YOUR_GITHUB_USERNAME>/configure, by clicking the "show API token" button. Also See: https://wiki.jenkins-ci.org/display/JENKINS/Authenticating+scripted+clients
  • JENKINS_JOB_URL_<REPO_NAME> (optional)
    Only required for the trigger Jenkins build script, to know which job to trigger a build for when repository collaborator posts a comment to the bot. E.g. JENKINS_JOB_URL_NODE=https://ci.nodejs.org/job/node-test-pull-request
  • JENKINS_BUILD_TOKEN_<REPO_NAME> (optional)
    Only required for the trigger Jenkins build script. The authentication token configured for a particular Jenkins job, for remote scripts to trigger builds remotely. Found on the job configuration page in Build Triggers -> Trigger builds remotely (e.g., from scripts).
  • LOGIN_CREDENTIALS
    Username and password used to protected the log files exposed in /logs. Expected format: username:password.
  • KEEP_LOGS
    Number of days to keep rotated log files, defaults to 10 if not set.
  • LOGS_DIR
    Directory where logs should be written and exposed by the /logs endpoint.

Developing Locally

The bot will try to load a .env file at the root of the project if it exists to set environment varaibles. You will need to create one similar to this:

GITHUB_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
SSE_RELAY=https://hook-relay.herokuapp.com

Note the additional SSE_RELAY variable: When developing locally, it is difficult to setup a GitHub webhook pointing to the computer you are developing on. An easy workaround is to set the SSE_RELAY to the url of a SSE relay server that will send the GitHub events via Server Sent Events instead. Another option is to use ngrok.

You can use the TestOrgPleaseIgnore GitHub Organization, to test your changes. Actions performed on the repos there will be sent to the SSE Relay. If you use your own Organization/Repository, remember to set the webhook Secret to the same value as GITHUB_WEBHOOK_SECRET (default hush-hush), and to change the content type to application/json (default on the GitHub interface is application/x-www-form-urlencoded, which will not work with the bot).

The GITHUB_WEBHOOK_SECRET environment variable is not required when using the relay.

Run the bot:

$ npm start

When developing a script, it is likely that you will only want to run the script(s) that you are working on. You may pass an additional glob argument to specify which scripts to run.

$ SCRIPTS=./scripts/my-new-event-handler.js npm start

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].