https://github.com/codelenny/auto-comment-bot

Automatically post comments on issues and pull requests
https://github.com/codelenny/auto-comment-bot

Last synced: 20 days ago
JSON representation

Automatically post comments on issues and pull requests

• Host: GitHub
• URL: https://github.com/codelenny/auto-comment-bot
• Owner: CodeLenny
• Created: 2018-06-29T21:15:54.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-01T01:02:13.000Z (about 6 years ago)
• Last Synced: 2025-02-28T22:28:20.019Z (over 1 year ago)
• Language: JavaScript
• Size: 274 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
================

auto-comment-bot

================

.. image:: https://auto-comment-bot.glitch.me/meta/outdated/time.svg

  :target: https://github.com/apps/auto-comment-bot

.. image:: https://gitlab.com/CodeLenny/auto-comment-bot/badges/master/pipeline.svg

  :target: https://gitlab.com/CodeLenny/auto-comment-bot/commits/master

.. image:: https://codecov.io/gh/CodeLenny/auto-comment-bot/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/CodeLenny/auto-comment-bot

.. image:: https://badges.greenkeeper.io/CodeLenny/auto-comment-bot.svg

   :alt: Greenkeeper badge

   :target: https://greenkeeper.io/

Automatically post comments when issues and pull requests are opened.

Features

========

- Support for multiple templates per-repository

- Conditionally comment depending on GitHub variables such as title, body, author, time of post, etc.

- Templating support for all the GitHub variables

Hosted Application

==================

A copy of the application is hosted for your convinence.

Go to https://github.com/apps/auto-comment-bot to install it for your repository.

The application is currently hosted on https://glitch.com/ to reduce costs,

but this means that the uptime is out of my hands, and use of the hosted server is at your own risk.

See https://glitch.com/~auto-comment-bot for the source application.

Setup

=====

* Copy ``.env.example`` into ``.env``

* Choose a webhook secret in ``.env``.

* If developing locally or from behind a firewall, sign up for Smee: https://smee.io/new

  Copy the smee URL into ``.env``, under ``WEBHOOK_PROXY_URL``

* Create a new GitHub App: https://github.com/settings/apps/new

  * If you are using smee, use the URL provided.  Otherwise, use the address of the server.

  * Use the webhook secret from ``.env``.

  * Select **read-only** permission for the repository, and **read/write** access for issues and pull requests

  * Select issue and pull requests for webhooks

* Download a private key for the app.  Save it inside the ``auto-comment-bot`` folder.

* Run ``npm install``

* Run ``npm start``