A repository's Feed page shows how your codebase is changing as you commit to your default branch. The Feed displays a reverse chronological listing of each significant event that has recently occurred during Code Climate's quality and security analysis.
Your repository’s Feed page is the main hub for you to review Code Climate’s analysis data.
When any of the following events occur during an analysis, we’ll post an update to your Feed:
- A file's letter grade increases or decreases. For example, a Ruby or PHP file goes from a C to a B.
- New code is added to your codebase. The Feed will show you its initial grade.
- Test coverage improves or declines.
We’ll also post a weekly summary to your Feed (on Monday), which shows information like how many files were changed, inserted, and deleted in the past seven days.
The very first analysis that Code Climate runs on your repository (directly after the repository is added) will never result in any Feed updates. Only the second and subsequent analyses can produce Feed updates. It's also important to note that your Feed may not update for every commit.
You can always check to see when Code Climate last analyzed your repository, by looking in the top-right corner of the Feed page for a SHA value. This is the SHA associated with the most recent commit to your default branch analyzed by Code Climate.
Next to the SHA is a "refresh" button, which enables you to manually trigger a new analysis. If you find yourself triggering an analysis manually on a regular basis, that may be sign that a deeper problem exists. To troubleshoot, we first recommend checking to make sure that our webhook is installed. If the problem persists, please contact support.
A repository's GPA is displayed next to the Feed.
Hovering over the GPA maps colors to letter grades. The amount of real-estate given to any given color indicates how prevalent the letter grade is in the repository.
If your repository has not received grades for your individual files or an overall GPA, check to make sure that you've specified a
ratings path in your
.codeclimate.yml. More information can be found in our Ratings doc.
A repository's lowest graded code appears next to the Feed, as a hotspot. The poorest graded code is listed first and only code with a C, D, or F rating is included.
It's best to be generally aware of your repository's hotspots. Hotspots may represent the largest concentration of your technical debt and they may be the best long-term refactoring targets. That said, if you're just starting out with Code Climate, don't focus too much on improving low-graded legacy code. Instead, focus on improving code that is added/modified from this point forward. Your Feed and notifications will point you in the right direction.
If you've set up test coverage, the overall percentage of your default branch currently covered by your testing suite will be displayed next to the Feed.
To learn more about how to get our Test Coverage feature set up, check out our help doc!
Want to show off your repository's GPA or test coverage percentage? Use our awesome badges, which are displayed next to the Feed, under your GPA. Click on these badges to view their embed snippets.
You can also access those by appending
/badges to the end of your repo's Code Climate URL, like this:
You can track Feed updates via an RSS reader. To view your Feed's RSS URL, click the button at the bottom left of the page.
Your RSS URL contains a secret token. Anyone with the URL can view your Feed