jest-coverage-comment-action

Comments a PR with the coverage (jest)

---

Table of Contents

• Inputs
  • github-token
  • jest-command
  • only-changes
  • working-directory
  • delete-previous
• Example of usage
• Example using a custom jest command
• Development
  • Close release
  • Documentation

Inputs

github-token

Required The github token to comment in the PR.

jest-command

Optional The command used to generate the coverage. Default: npx jest --coverage

only-changes

Optional Add parameter to show the coverage only for the changed files. Default: true

working-directory

Optional The command used to generate the coverage. Default: ''

delete-previous

Optional Delete previous comments before adding a new one. Default: true

Example of usage

uses: raulanatol/jest-coverage-comment-action@v1.0.0
with:
  github-token: ${{ secrets.GITHUB_TOKEN }}'

Example using a custom jest command and working directory

.github/workflows/main.yml

on: pull_request

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Hello world action step
        id: hello
        uses: raulanatol/jest-coverage-comment-action@v1.0.0
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          jest-command: 'npm run jest-ci'
          working-directory: 'packages/my-package'

Development

Close release

To close a release you only need to execute the makefile with release_{major|minor|patch}

Example:

make release_minor

Documentation

To generate the documentation you only need to execute the makefile with docs.

Using doctoc

make docs