codelyze/action

A GitHub action to upload coverage to codelyze.com.

Usage

- name: Upload coverage
  uses: codelyze/action@2.1.0
  with:
    token: ${{ secrets.CODELYZE_TOKEN }}
    path: coverage/lcov.info

Permission

The following workflow permissions are necessary:

permissions:
  contents: read
  statuses: write

Inputs

codelyze/action uses the following inputs:

Name	Description	Required	Default
token	Coverage upload token generated when project is created on codelyze.com	yes
path	Relative path to the coverage file	yes
gh-token	GITHUB_TOKEN (permissions contents: write and pull-requests: write) or a repo scoped Personal Access Token (PAT).	no	GITHUB_TOKEN
annotations	Add annotations to uncovered hunks	no	true
threshold	The minimum coverage allowed. If coverage is lower than this, the action will fail	no	0
difference-threshold	The minimum total difference allowed between the current commit and the reference one	no	0
patch-threshold	the minimum value for patch coverage: the minimum ratio of new lines that are not covered.	no	0
skip-empty-patch	If true don't even add a commit status for a patch that has no changes.	no	false

Outputs

codelyze/action has the following outputs:

Name	Description
coverage	Object that contains linesFound, linesCovered and rate of the commit's coverage
difference	The coverage rate's difference between the commit and HEAD
patch	Object that contains linesFound, linesCovered, and rate of the commit's patch coverage