---
title: "Kiwi for GitHub Actions"
description: "Report check results from GitHub Actions to a run's Verify step with a checker key."
canonical: "https://kiwiflow.io/integrations/github-actions"
---

# Kiwi for GitHub Actions

Report check results from GitHub Actions to a run's Verify step with a checker key.

- Posts named check results over HTTP with a checker key. The key can report only the checks you choose in one project.
- Checks reserved for CI accept results only from a checker key.
- Records each result against the candidate under review. A pass counts toward Verify; a fail means the run needs rework.
- Records a retried report once.
- Kiwi does not start pipelines or read their logs. It records the results your pipeline sends.

## Set up

Store your checker key as the `KIWI_CHECKER_KEY` secret and add `report-kiwi-check.sh` from the setup guide to your repository.

This job in `.github/workflows/kiwi.yml` runs after your tests and reports the `tests-pass` check as `pass` or `fail`:

```
on:
  workflow_dispatch:
    inputs:
      kiwi_run_id:
        description: Kiwi run ID
        required: true

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm test

  report:
    needs: test
    if: always()
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - env:
          KIWI_CHECKER_KEY: ${{ secrets.KIWI_CHECKER_KEY }}
          KIWI_RUN_ID: ${{ inputs.kiwi_run_id }}
        run: >
          ./report-kiwi-check.sh tests-pass
          ${{ needs.test.result == 'success' && 'pass' || 'fail' }}
          "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
```

Start the workflow with the Kiwi run ID as its input.

Replace `tests-pass` with the check ID from your plan.

## More CI/CD integrations

- [Kiwi for AWS CodeBuild](https://kiwiflow.io/integrations/aws-codebuild.md): Report check results from AWS CodeBuild to a run's Verify step with a checker key.
- [Kiwi for Azure Pipelines](https://kiwiflow.io/integrations/azure-pipelines.md): Report check results from Azure Pipelines to a run's Verify step with a checker key.
- [Kiwi for Bitbucket Pipelines](https://kiwiflow.io/integrations/bitbucket-pipelines.md): Report check results from Bitbucket Pipelines to a run's Verify step with a checker key.
- [Kiwi for Bitrise](https://kiwiflow.io/integrations/bitrise.md): Report check results from Bitrise to a run's Verify step with a checker key.
- [Kiwi for Buildkite](https://kiwiflow.io/integrations/buildkite.md): Report check results from Buildkite to a run's Verify step with a checker key.
- [Kiwi for CircleCI](https://kiwiflow.io/integrations/circleci.md): Report check results from CircleCI to a run's Verify step with a checker key.
- [Kiwi for Codemagic](https://kiwiflow.io/integrations/codemagic.md): Report check results from Codemagic to a run's Verify step with a checker key.
- [Kiwi for GitLab CI/CD](https://kiwiflow.io/integrations/gitlab-ci.md): Report check results from GitLab CI/CD to a run's Verify step with a checker key.
- [Kiwi for Google Cloud Build](https://kiwiflow.io/integrations/google-cloud-build.md): Report check results from Google Cloud Build to a run's Verify step with a checker key.
- [Kiwi for Jenkins](https://kiwiflow.io/integrations/jenkins.md): Report check results from Jenkins to a run's Verify step with a checker key.
- [Kiwi for TeamCity](https://kiwiflow.io/integrations/teamcity.md): Report check results from TeamCity to a run's Verify step with a checker key.
- [Kiwi for Travis CI](https://kiwiflow.io/integrations/travis-ci.md): Report check results from Travis CI to a run's Verify step with a checker key.

- [Get started](https://kiwiflow.io/get-started)
- [Read the setup guide](https://docs.kiwiflow.io/ci-reporting)