{"id":19220452,"url":"https://github.com/louisbrunner/checks-action","last_synced_at":"2025-04-05T21:11:44.773Z","repository":{"id":38615473,"uuid":"243968751","full_name":"LouisBrunner/checks-action","owner":"LouisBrunner","description":"GitHub Action which wraps calls to GitHub Checks API","archived":false,"fork":false,"pushed_at":"2024-04-04T17:26:02.000Z","size":2557,"stargazers_count":160,"open_issues_count":4,"forks_count":48,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-14T06:03:05.339Z","etag":null,"topics":["actions","checks","checks-api","github","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LouisBrunner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["LouisBrunner"]}},"created_at":"2020-02-29T12:54:51.000Z","updated_at":"2024-05-01T03:30:23.027Z","dependencies_parsed_at":"2023-10-16T20:24:26.831Z","dependency_job_id":"384d4882-ebae-47e5-82d9-ff23a88640b8","html_url":"https://github.com/LouisBrunner/checks-action","commit_stats":{"total_commits":60,"total_committers":9,"mean_commits":6.666666666666667,"dds":0.5833333333333333,"last_synced_commit":"311ef1eda1042009ba5796e2fe8eab7086dc3688"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LouisBrunner%2Fchecks-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LouisBrunner%2Fchecks-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LouisBrunner%2Fchecks-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LouisBrunner%2Fchecks-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LouisBrunner","download_url":"https://codeload.github.com/LouisBrunner/checks-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399886,"owners_count":20932880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","checks","checks-api","github","hacktoberfest"],"created_at":"2024-11-09T14:35:13.066Z","updated_at":"2025-04-05T21:11:44.745Z","avatar_url":"https://github.com/LouisBrunner.png","language":"TypeScript","funding_links":["https://github.com/sponsors/LouisBrunner"],"categories":[],"sub_categories":[],"readme":"# GitHub Actions: `checks-action` ![build-test](https://github.com/LouisBrunner/checks-action/workflows/build-test/badge.svg)\n\nThis GitHub Action allows you to create [Check Runs](https://developer.github.com/v3/checks/runs/#create-a-check-run) directly from your GitHub Action workflow. While each job of a workflow already creates a Check Run, this Action allows to include `annotations`, `images`, `actions` or any other parameters supported by the [Check Runs API](https://developer.github.com/v3/checks/runs/#parameters).\n\n## Usage\n\nThe following shows how to publish a Check Run which will have the same status as your job and contains the output of another action. This will be shown predominantly in a Pull Request or on the workflow run.\n\n```yaml\nname: \"build-test\"\non: [push]\n\njobs:\n  test_something:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v1\n    - uses: actions/create-outputs@v0.0.0-fake\n      id: test\n    - uses: LouisBrunner/checks-action@v2.0.0\n      if: always()\n      with:\n        token: ${{ secrets.GITHUB_TOKEN }}\n        name: Test XYZ\n        conclusion: ${{ job.status }}\n        output: |\n          {\"summary\":\"${{ steps.test.outputs.summary }}\"}\n```\n\nSee the [examples workflow](.github/workflows/examples.yml) for more details and examples (and see the [associated runs](https://github.com/LouisBrunner/checks-action/actions?query=workflow%3Aexamples) to see how it will look like).\n\n### Permissions\n\nWhen the action is run as part of a Pull Request, your workflow might fail with the following error: `Error: Resource not accessible by integration`.\n\nYou can solve this in multiple ways:\n\n* Increase the permissions given to `GITHUB_TOKEN` (see https://github.com/actions/first-interaction/issues/10#issuecomment-1232740076), please note that you should understand the security implications of this change\n* Use a Github App token instead of a `GITHUB_TOKEN` (see https://github.com/LouisBrunner/checks-action/issues/26#issuecomment-1232948025)\n\nMost of the time, it means setting up your workflow this way:\n\n```yaml\nname: \"build-test\"\non: [push]\n\njobs:\n  test_something:\n    runs-on: ubuntu-latest\n    permissions:\n      checks: write\n      contents: read\n    steps:\n    - uses: actions/checkout@v1\n    - uses: actions/create-outputs@v0.0.0-fake\n      id: test\n    - uses: LouisBrunner/checks-action@v2.0.0\n      if: always()\n      with:\n        token: ${{ secrets.GITHUB_TOKEN }}\n        name: Test XYZ\n        conclusion: ${{ job.status }}\n        output: |\n          {\"summary\":\"${{ steps.test.outputs.summary }}\"}\n```\n\nNotice the extra `permissions` section.\n\n## Inputs\n\n### `repo`\n\n_Optional_ The target repository (`owner/repo`) on which to manage the check run. Defaults to the current repository.\n\n### `sha`\n\n_Optional_ The SHA of the target commit. Defaults to the current commit.\n\n### `token`\n\n**Required** Your `GITHUB_TOKEN`\n\n### `name`\n\n**Required** for creation, the name of the check to create (mutually exclusive with `check_id`)\n\n### `check_id`\n\n**Required** for update, ID of the check to update (mutually exclusive with `name`)\n\n### `conclusion`\n\n_Optional_ (**Required** if `status` is `completed`, the default) The conclusion of your check, can be either `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `skipped`\n\n### `status`\n\n_Optional_ The status of your check, defaults to `completed`, can be either `queued`, `in_progress`, `completed`\n\n### `action_url`\n\n_Optional_ The URL to call back to when using `action_required` as a `conclusion` of your check or when including `actions`\n\nSee [Check Runs API (`action_required`)](https://developer.github.com/v3/checks/runs/#parameters) or [Check Runs API (`actions`)](https://developer.github.com/v3/checks/runs/#actions-object) for more information\n\nNote that this will override `details_url` (see next) when `conclusion` is `action_required` or when `actions` is provided (the two inputs set the same check attribute, `details_url`)\n\n### `details_url`\n\n_Optional_ A URL with more details about your check, can be an third-party website, a preview of the changes to your Github Pages, etc\n\nNote that this will be overridden by `action_url` (see previous) when `conclusion` is `action_required` or when `actions` is provided (the two inputs set the same check attribute, `details_url`)\n\n### `output`\n\n_Optional_ A JSON object (as a string) containing the output of your check, required when using `annotations` or `images`.\n\nSupports the following properties:\n\n - `title`: _Optional_, title of your check, defaults to `name`\n - `summary`: **Required**, summary of your check\n - `text_description`: _Optional_, a text description of your annotation (if any)\n\nSee [Check Runs API](https://developer.github.com/v3/checks/runs/#output-object) for more information\n\n### `output_text_description_file`\n\n_Optional_ Path to a file containing text which should be set as the `text_description` property of `output`'. Can contain plain text or markdown.\n\nNote that this will be ignored if `output` is not provided. When `output` is provided with a text_description, this input will take precedence and override it.\n\n### `annotations`\n\n_Optional_ A JSON array (as a string) containing the annotations of your check, requires `output` to be included.\n\nSupports the same properties with the same types and names as the [Check Runs API](https://developer.github.com/v3/checks/runs/#annotations-object)\n\n### `images`\n\n_Optional_ A JSON array (as a string) containing the images of your check, requires `output` to be included.\n\nSupports the same properties with the same types and names as the [Check Runs API](https://developer.github.com/v3/checks/runs/#images-object)\n\n### `actions`\n\n_Optional_ A JSON array (as a string) containing the actions of your check.\n\nSupports the same properties with the same types and names as the [Check Runs API](https://developer.github.com/v3/checks/runs/#actions-object)\n\nNote that this will override `details_url` as it relies on `action_url` (the two inputs set the same check attribute, `details_url`)\n\n## Outputs\n\n### `check_id`\n\nThe ID of the created check, useful to update it in another action (e.g. non-`completed` `status`)\n\n## Issues\n\n - Action Required conclusion: button doesn't work?\n - Action elements: button doesn't work?\n - Non-completed status: too many arguments required\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flouisbrunner%2Fchecks-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flouisbrunner%2Fchecks-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flouisbrunner%2Fchecks-action/lists"}