Docs GitHub

Introduction

Installation, Administration & Maintenance

Infrastructure

Platform Components

API

Configuration Options

Sidekiq Web UI

Worker

Configuration Options

Cache

Configuration Options

Badger

Installation

Requirements Creating a GitHub App

Installing on Kubernetes using Helm

Choosing a Storage Medium Initializing the API and Web UI Initializing the Worker instance Enabling the Badger Enabling Worker Cache

Starting an Instance Using Docker Compose

Administration

Users Permissions Service Tokens Repositories Personal Access Tokens Badges Organization & Repository Settings Sidekiq Dashboard Caches

Configuring a Repository to Use Cocov

Checks & Limits: The Manifest File Uploading Test Coverage to Cocov Protecting the Manifest File Blocking PRs using Cocov Results Supported Coverage Formats

Plugin Development

What is a Cocov Plugin Cocov SDKs Testing Plugins Locally with PlugDev Distributing Your Plugin

Troubleshooting

Badges

Last updated Feb 26, 2024

Badges are small images usually present in README files indicating compliance or showing coverage levels of repositories. Cocov includes a badge server capable of emitting information regarding coverage level and the amount of issues present in a repository’s default branch, and is widely available for all users from the repository page:

Repository Badges

Badges are available on instances that have the badge server configured and exposed to the public internet.

Why Exposing the Badges Server #

GitHub proxies and caches images displayed in their domains, meaning that your badge server must be publicly accessible. More information can be obtained from GitHub engineering Blog on Proxying User Images and Sidejack Prevention.