Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
package

GitHub Action

Knip Reporter

v1.0.2

Knip Reporter

package

Knip Reporter

Comment on a pull-request with Knip results

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Knip Reporter

              
  uses: Codex-/[email protected]
Learn more about this action in Codex-/knip-reporter

Choose a version

GitHub Action: knip-reporter

⚙️📄 Report the results from knip on pull requests.

GitHub Workflow Status GitHub Marketplace

This action runs knip, parses the results, and posts the report as comments on the related pull request.

Usage

name: Pull Request
on:
  pull_request:

steps:
  - name: Post the knip results
    uses: codex-/knip-reporter@v1

Config

The following inputs are supported

Input Description Required Default
token GitHub Personal Access Token for making API requests. false ${{ github.token }}
command_script_name The package script that runs knip. false knip
comment_id ID to use when updating the PR comment. Spaces will be replaced with dashes. false ${{ github.workflow }}-knip-reporter
ignore_result Do not fail the action run if knip results are found. false false

Issues

If you encounter a case where comments are not being posted, or known sections are missing from the report, please enable step debug logging and create an issue with the results and expected behaviour.

APIs Used