/jest-github-action

Jest action adding checks with annotations to your pull requests and coverage table as comments

Primary LanguageTypeScriptMIT LicenseMIT

Jest Github Action

Main features:

  • Add status checks with code annotations to your pull requests
  • Comment your pull requests with code coverage table (if tests succeeded)

Coverage example

Coverage

Check annotations example

Fail

Usage

You can now consume the action by referencing the v1 branch

uses: mattallty/jest-github-action@v1
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Overriding the test command

By default, this action will execute npm test to run your tests. You can change this behavior by providing a custom test-command like this:

uses: mattallty/jest-github-action@v1
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  # this is just an example, this could be any command that will trigger jest
  test-command: "yarn test"

Running tests only on changed files

uses: mattallty/jest-github-action@v1
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  # Runs tests related to the changes since the base branch of your pull request
  # Default to false if not set
  changes-only: true

See the actions tab for runs of this action! 🚀