Skip to content

Getting started with Eclipse CARE

Install

Basic usage

Authentication

Some checks require an authentication token on GitHub or on Eclipse's GitLab.

Obtaining a token:

On GitHub, go to your personal Settings > Developer Settings > Personal access tokens > Tokens (classic). Click on Generate new token. Select All public repositories.

On GitLab, go to your personal Settings >

Authentication data can be provided in different ways, in order of precedence:

  1. From environment variables: GH_AUTH_TOKEN or GL_AUTH_TOKEN.
  2. From a custom configuration file provided on command line, with the -c|--conf option.

The format expected for the configuration file is a classic .ini syntax, e.g. 

[GitHub]
gh_token = ghp_xxxxxxxxxxxxxxxxxxxxx

If no authentication is provided, the script will use unauthenticated access. This should work, but rate-limiting constraints will be applied, especially with GitHub.