{"id":26683045,"url":"https://github.com/agyemanjp/ci-checks-action","last_synced_at":"2025-04-12T13:51:45.265Z","repository":{"id":40714888,"uuid":"274504376","full_name":"agyemanjp/ci-checks-action","owner":"agyemanjp","description":"Create Github annotated checks from tooling scripts output","archived":false,"fork":false,"pushed_at":"2023-03-05T02:17:07.000Z","size":616,"stargazers_count":4,"open_issues_count":6,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T15:00:52.259Z","etag":null,"topics":["annotation","check","ci","continuous-integration","github-actions"],"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/agyemanjp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2020-06-23T20:39:13.000Z","updated_at":"2023-06-26T05:23:29.000Z","dependencies_parsed_at":"2024-11-20T14:38:25.552Z","dependency_job_id":"3c3c9770-2cc3-4b28-9a38-791ca0241490","html_url":"https://github.com/agyemanjp/ci-checks-action","commit_stats":{"total_commits":31,"total_committers":6,"mean_commits":5.166666666666667,"dds":0.3870967741935484,"last_synced_commit":"eff79f939db3c81eb8e4101538a4fb702511895a"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agyemanjp%2Fci-checks-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agyemanjp%2Fci-checks-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agyemanjp%2Fci-checks-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agyemanjp%2Fci-checks-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agyemanjp","download_url":"https://codeload.github.com/agyemanjp/ci-checks-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248575782,"owners_count":21127273,"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":["annotation","check","ci","continuous-integration","github-actions"],"created_at":"2025-03-26T08:29:05.231Z","updated_at":"2025-04-12T13:51:45.237Z","avatar_url":"https://github.com/agyemanjp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ci-checks-action\nCreate Github annotated checks from script output files\n\n## Description\nCreate Github checks (with annotations for pull request diffs) from the output (in a [standardized JSON format](https://gist.githubusercontent.com/agyemanjp/0f43de0639a7ec872e9ebcbe6166d5d9/raw/ccb90a9298561f2ba7c07ba6843b2b25244f9cf7/code-check-general.schema.json)) of custom code check scripts. The annotations include a summary of errors and warnings, including links to the line numbers of any errors or warnings. It works on both pull requests (only on changed files) and pushes.\n\n## Rationale\nThis action allows for more flexibility in implementing code checks. Instead on bundling specific checks, it allows you to use any custom script, as long as it outputs its results to a local JSON file in the proper format.\n\n## Usage Example\nIn `.github/workflows/nodejs.yml`:\n\n```yml\nname: Example Workflow\n\non: [pull_request]\n\njobs:\n  checks:\n    runs-on: ubuntu-latest\n\n    strategy:\n      matrix:\n        node-version: [12.x]\n\n    steps:\n      - name: Checkout Repository\n        uses: actions/checkout@v2\n        with: \n          persist-credentials: false\n\n      - name: Setup Node.js ${{ matrix.node-version }}\n        uses: actions/setup-node@v1\n        with:\n          node-version: ${{ matrix.node-version }}\n        \n      - name: Install\n        run: npm ci --no-audit --prefer-offline \n\n      - name: Build\n        run: npm run compile --if-present\n\n      - name: Lint\n        run: npm run lint\n        continue-on-error: true\n        \n      - name: Test\n        run: npm run test\n        continue-on-error: true\n        \n      - name: Annotate Checks\n        uses: agyemanjp/ci-checks-action@2.1.1\n        with:\n          ghToken: ${{ secrets.GITHUB_TOKEN }}\n          checks: '[\n              {\n                \"name\": \"lint\",\n                \"fileName\": \".lint.run.json\",\n                \"prChangesOnly\": true\n              },\n              {\n                \"name\": \"test\",\n                \"fileName\": \".test.run.json\",\n                \"prChangesOnly\": false\n              }\n            ]'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagyemanjp%2Fci-checks-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagyemanjp%2Fci-checks-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagyemanjp%2Fci-checks-action/lists"}