MicroFeedback logoMicroFeedback
GitHub

microfeedback-github

The microfeedback-github backend collects user feedback to your GitHub repo’s issue tracker.

GitHub source: MicroFeedback/microfeedback-github

API

POST /<githubUser>/<githubRepo>

Post a new feedback message on the issue tracker for the given GitHub repo.

A single instance may be used to post issues to multiple GitHub repos.

The path includes:

  • githubUser (required): Github username or organization.
  • githubRepo (required): Repo name.

The JSON payload contains the following keys:

  • body (required): The feedback content.
  • screenshotURL: Optional URL to a screenshot image.
  • extra: Optional object containing optional information to include in the issue.

Deploy to Now

If you already have a Now account and a GitHub API token associated with your feedback bot, you can deploy microfeedback-github to now using the now CLI.

One command deploy

now microfeedback/microfeedback-github

You will be prompted to enter the GitHub API token associated with your feedback bot’s GitHub account.

For more detailed setup instructions, see the next section.

Detailed instructions

  • Sign in to the GitHub account that will post issues, e.g. myapp-issuebot.
  • Go here to generate a new personal access token.
  • Enter a description, e.g. “For posting issues” and select the “repo” scope.

npm i -g now
  • Deploy the service with now. When prompted, pass the GitHub token you generated previously.
now microfeedback/microfeedback-github
  • You’re done! Copy the URL returned by now. This is the URL that clients will use to access the service.

Deploy to Heroku

If you prefer to deploy to Heroku, use the deployment button below or deploy with Git.

One click deploy

Deploy to Heroku

Deployment with Git

git clone https://github.com/microfeedback/microfeedback-github.git
cd microfeedback-github
heroku create
heroku config:set GH_TOKEN=your-bot-token
git push heroku master

Configuration

Configuration is defined through environment variables and can be passed when you deploy microfeedback-github.

now microfeedback/microfeedback-github -e GH_TOKEN=abc123 -e ALLOWED_REPOS=sloria/website,sloria/another-website

The following options are available:

  • GH_TOKEN (required): The GitHub API token associated with your feedback bot’s account.
  • ALLOWED_REPOS: A comma-delimited list of GitHub repos that maybe posted to. If '*', allow posting to any repo that the GH_TOKEN has access to (incl. any public repos). Default: '*'

Spam detection with Akismet (Optional)

microfeedback-github supports spam detection using Akismet.

  • AKISMET_API_KEY: Akismet API key to use for spam detection. If set, all input will be checked using the Akismet API. An error response will be returned when spam is detected.
  • AKISMET_ENABLED: Spam checking will automatically be enabled if AKISMET_API_KEY is set. If you want to disable spam checking anyway, set AKISMET_ENABLED to false.

Toxicity scoring with Perspective API (Optional)

microfeedback-github supports toxicity scoring using the Perspective API.

  • PERSPECTIVE_API_KEY: Perspective API key to use for toxicity scoring. Toxicity information will be included in posted issues.
  • PERSPECTIVE_ENABLED: Toxicity scoring will automatically be enabled if PERSPECTIVE_API_KEY is set. If you want to disable toxicity scoring anyway, set PERSPECTIVE_ENABLED to false.
Edit this page