An open API service indexing awesome lists of open source software.

https://github.com/7codewizard/diff-patch


https://github.com/7codewizard/diff-patch

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README

          

# codelyze/action

[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
![Coverage](https://api.codelyze.com/v1/projects/badge/clb_d6da3631ad505ccb1e07b10e4a5d69cb?r=1)

A GitHub action to upload coverage to codelyze.com.

## Usage

```yml
- 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:

```yml
permissions:
contents: read
statuses: write
```

### Inputs

`codelyze/action` uses the following inputs:

| Name | Description | Required | Default |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | -------------- |
| `gh-token` | `GITHUB_TOKEN` (permissions `contents: write` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | no | `GITHUB_TOKEN` |
| `token` | Coverage upload token generated when project is created on codelyze.com | yes | |
| `path` | Relative path to the coverage file | yes | |

### Outputs

`codelyze/action` has the following outputs:

| Name | Description |
| ------------ | ------------------------- |
| `percentage` | Total percentage coverage |