lintel-github-action 0.0.9

GitHub Action binary for Lintel — creates Check Runs with inline annotations
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# lintel-github-action

[![Crates.io](https://img.shields.io/crates/v/lintel-github-action.svg)](https://crates.io/crates/lintel-github-action)
[![docs.rs](https://docs.rs/lintel-github-action/badge.svg)](https://docs.rs/lintel-github-action)
[![GitHub](https://img.shields.io/github/stars/lintel-rs/lintel?style=flat)](https://github.com/lintel-rs/lintel)
[![License](https://img.shields.io/crates/l/lintel-github-action.svg)](https://github.com/lintel-rs/lintel/blob/master/LICENSE)

GitHub Action binary for [Lintel](https://github.com/lintel-rs/lintel). Creates a GitHub Check Run named "Lintel" with inline annotations on pull requests using the [Checks API](https://docs.github.com/en/rest/checks/runs).

## How it works

1. Runs Lintel validation on the specified files
2. Collects errors with file path, line, and column information
3. Creates a GitHub Check Run with annotations (batched at 50 per API call)
4. Reports success/failure with a summary table

## Environment variables

| Variable            | Description                                                                   |
| ------------------- | ----------------------------------------------------------------------------- |
| `GITHUB_TOKEN`      | GitHub token with `checks:write` permission (required)                        |
| `GITHUB_REPOSITORY` | Repository in `owner/repo` format (set automatically by GitHub Actions)       |
| `GITHUB_SHA`        | Commit SHA to annotate (set automatically by GitHub Actions)                  |
| `GITHUB_API_URL`    | GitHub API base URL (set automatically, defaults to `https://api.github.com`) |

## Usage

This binary is used by the [lintel-rs/action](https://github.com/lintel-rs/action) GitHub Action. See that repository for usage instructions.

## License

Apache-2.0