Codecov Logo

Streamline Code Coverage with Slack

Codecov App for Slack brings the power of code coverage directly into your Slack channels, enabling you and your team to stay informed and proactive about your code's quality without ever leaving Slack.

A Codecov account is required to configure and use this app.

Configuration Steps

  1. Ensure you have a Codecov account. If not, .
  2. Click the "Add to Slack" button to install the app to your Slack workspace.
  3. Once installed, use the "/codecov login" command in Slack to link your Codecov account.
  4. Follow the prompts to authorize the connection between Slack and Codecov.
  5. After successful connection, you can start using Codecov commands in your Slack channels.

Code Coverage Changes at a Glance

Get automated updates on code coverage changes for your PRs with /codecov notify. Customize notifications for targeted updates right in Slack, allowing you to address coverage decreases or celebrate increases without waiting around for PR calculations.

Slack onboarding screenshot

Efficiently Compare Commits

Use /codecov compare to get a snapshot comparison between two commits, identifying potential regressions or celebrating improvements in your codebase's coverage. It's a direct line to understanding and improving your project's code quality.

Commit comparison screenshot

Comprehensive PR List

Gain insight into PRs and coverage changes with a simple slash command. This isn't just limited to PRs; access a list of flags, components, commits, and branches for a full spectrum view on your project's health, directly in your Slack workspace.

PR list screenshot

Check out supported commands

Auth Commands

/codecov login - Login to a service

Authenticate your Codecov account within Slack.

/codecov logout - Logout of current active service

Log out of your current Codecov session.

User Commands

/codecov organizations - Get a list of organizations that user has access to

Retrieve a list of organizations associated with your Codecov account.

/codecov owner username= service= - Get owner's information

Fetch details about the owner of a specific organization.

/codecov users username= service= Optional params: is_admin= activated= page= page_size= - Get a list of users for the specified owner

Get a list of users associated with the specified organization.

Repositories Commands

/codecov repos username= service= Optional params: names= active= page= page_size= - Get a list of repos for the specified owner

Retrieve a list of repositories for the specified organization.

/codecov repo repository= username= service= - Get repo information

Fetch detailed information about a specific repository.

/codecov repo-config username= service= repository= - Get the repository configuration for the specified owner and repository

Access the configuration settings for a specific repository.

Branches Commands

/codecov branches username= service= repository= Optional params: ordering= author= page= page_size= - Get a list of branches for the repository

Retrieve a list of branches associated with a specific repository.

/codecov branch repository= username= service= branch= - Get branch information

Fetch detailed information about a specific branch.

Commits Commands

/codecov commits username= service= repository= Optional params: branch= page= page_size= - Get a list of commits for the repository

Retrieve a list of commits associated with a specific repository.

/codecov commit repository= username= service= commitid= - Get commit information

Fetch detailed information about a specific commit.

Pulls Commands

/codecov pulls username= service= repository= Optional params: ordering= page= page_size= state= - Get a list of pulls for the repository

Retrieve a list of pull requests associated with a specific repository.

/codecov pull repository= username= service= pullid= - Get pull information

Fetch detailed information about a specific pull request.

Components Commands

/codecov components username= service= repository= Optional params: branch= sha= - Gets a list of components for the specified repository

Retrieve a list of components associated with a specific repository.

Flags Commands

/codecov flags username= service= repository= Optional params: page= page_size= - Gets a paginated list of flags for the specified repository

Access a list of flags associated with a specific repository.

/codecov coverage-trends username= service= repository= flag= Optional params: page= page_size= start_date= end_date= branch= interval=<1d,30d,7d> - Gets a paginated list of timeseries measurements aggregated by the specified interval

Retrieve coverage trends over time for a specific repository.

Comparison Commands

/codecov compare username= service= repository= - Get a comparison between two commits or a pull and its base

Fetch a comparison of coverage between two commits or a pull request.

/codecov compare-component username= service= repository= - Gets a component comparison

Retrieve a comparison of components between two commits.

/codecov compare-file username= service= repository= path= - Gets a comparison for a specific file path

Fetch a comparison of coverage for a specific file.

/codecov compare-flag username= service= repository= - Get a flag comparison

Retrieve a comparison of flags between two commits.

NOTE: You must either pass pullid= or both of head= base= in the comparison commands.

Coverage Commands

/codecov coverage-trend username= service= repository= Optional params: branch= end_date= start_date= interval=<1d,30d,7d> page= page_size= - Get a paginated list of timeseries measurements aggregated by the specified interval

Retrieve coverage trends over time for a specific repository.

/codecov file-coverage-report repository= username= service= path= Optional params: branch= sha= - Get coverage info for a single file specified by path

Fetch coverage information for a specific file in the repository.

/codecov commit-coverage-report repository= username= service= Optional params: path= branch= sha= component_id= flag= - Get line-by-line coverage info (hit=0/miss=1/partial=2)

Retrieve detailed line-by-line coverage information for a specific commit.

/codecov commit-coverage-totals repository= username= service= path= Optional params: path= branch= sha= component_id= flag= - Get the coverage totals for a given commit and the coverage totals broken down by file

Access the total coverage information for a specific commit.

Notifications Commands

/codecov notify username= service= repository= - Direct Notifications for a specific repo to a specific channel

Set up direct notifications for a specific repository in your Slack channel.

/codecov notify-off username= service= repository= - Turn off Notifications for a specific repo in a specific channel

Disable notifications for a specific repository in your Slack channel.