Documentation (Quality)Contact SupportCode Climate API

Slack

Suggest Edits

By using our Slack integration, Quality will automatically post notifications directly to your Slack room. Notifications will be posted whenever important events occur during our analysis (e.g., your code or test coverage gets better or worse).

Alerts are sent when:

  • any letter rating changes,
  • any new files are created with a rating of “C” or lower,
  • test coverage improves or declines.

Note: For an organization-owned repository, you must be in an organization's Owners group to perform the actions described in this article. Alternatively, if you added the repository in question by clicking Add Open Source Repo, you must have GitHub-rights to administer the repository.

Show Me How

The steps below explain how to setup and test Quality's Slack integration. Note that these steps will require you to move back and forth between Code Climate and Slack.

  1. In Slack, click the "Team Settings" arrow in the upper-left hand corner of the screen and select Configure Integrations.

365

  1. Find Code Climate and click Add.

959

  1. Select the room you would like Code Climate to post to, and click Add Code Climate Integration.

641

  1. Copy the Webhook URL from Step 2 in the Slack instructions.

820

  1. In a new browser window, navigate to your Code Climate Dashboard.
  2. Mouse over your repository's name and click Settings.

  1. Select the Integrations tab.
  2. Next to Slack, click Set Up.

  1. Paste the webhook URL into the Webhook URL field.

  2. Optional: Enter a Slack channel to send notifications to. Ensure you use a # character before the channel's name (e.g., #dev).

  3. Ensure Active is checked and click Save.

  1. To verify the Slack data is valid, click Test Service (this will post a sample message to your Slack room). If a green message appears at the top of the screen, all is well. If a red error message is displayed, see Troubleshooting below.

700

Troubleshooting

If you are seeing a red error message after clicking Test Service:

  • Ensure there are no leading or trailing spaces around the Webhook URL that you provided to Code Climate.
  • If you provide an optional channel name, ensure that you add a # character at the very front (e.g., #dev).

Updated 11 months ago