{"id":15045285,"url":"https://github.com/jenkinsci/checks-api-plugin","last_synced_at":"2025-07-18T08:05:06.316Z","repository":{"id":37700687,"uuid":"281973921","full_name":"jenkinsci/checks-api-plugin","owner":"jenkinsci","description":"Jenkins plugin that defines an API for Jenkins to publish checks to SCM platforms.","archived":false,"fork":false,"pushed_at":"2025-06-23T05:38:25.000Z","size":496,"stargazers_count":46,"open_issues_count":15,"forks_count":31,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-06-23T06:30:56.720Z","etag":null,"topics":["api-plugin","hacktoberfest","notifier","post-build","report"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/checks-api/","language":"Java","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/jenkinsci.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-23T14:27:35.000Z","updated_at":"2025-06-23T05:38:28.000Z","dependencies_parsed_at":"2024-01-11T22:04:00.948Z","dependency_job_id":"c3984438-553f-4461-81dd-0d2a6c1ab80d","html_url":"https://github.com/jenkinsci/checks-api-plugin","commit_stats":{"total_commits":316,"total_committers":21,"mean_commits":"15.047619047619047","dds":0.629746835443038,"last_synced_commit":"e5352d9534d45eb0869302f03912ef8c4c2a66d8"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/jenkinsci/checks-api-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fchecks-api-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fchecks-api-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fchecks-api-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fchecks-api-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/checks-api-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fchecks-api-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265724733,"owners_count":23817863,"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":["api-plugin","hacktoberfest","notifier","post-build","report"],"created_at":"2024-09-24T20:51:41.143Z","updated_at":"2025-07-18T08:05:06.290Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checks API Plugin\n[![Join the chat at https://gitter.im/jenkinsci/github-checks-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jenkinsci/github-checks-api)\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://issues.jenkins-ci.org/issues/?jql=component%20%3D%20checks-api-plugin)\n[![Jenkins](https://ci.jenkins.io/job/Plugins/job/checks-api-plugin/job/master/badge/icon?subject=Jenkins%20CI)](https://ci.jenkins.io/job/Plugins/job/checks-api-plugin/job/master/)\n[![GitHub Actions](https://github.com/jenkinsci/checks-api-plugin/workflows/CI/badge.svg?branch=master)](https://github.com/jenkinsci/checks-api-plugin/actions)\n[![codecov](https://codecov.io/gh/jenkinsci/checks-api-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/jenkinsci/checks-api-plugin)\n\nInspired by the [GitHub Checks API](https://docs.github.com/en/rest/reference/checks#runs), this plugin aims to provide a general API to allow Jenkins plugins publishing checks (or reports) to remote source code management (SCM) platforms (e.g. GitHub, GitLab, BitBucket, etc.).\n\nBy consuming this API, other plugins can publish check with customized parameters for a Jenkins build, such as status, summary, warnings, code annotations, or even images.\nImplementations of this API decide on how to make use of these parameters and where to publish the checks.\n\nKnown consumers:\n* [Warnings Next Generation Plugin](https://plugins.jenkins.io/warnings-ng)\n* [Code Coverage API Plugin](https://plugins.jenkins.io/code-coverage-api)\n* [JUnit Plugin](https://plugins.jenkins.io/junit/) - since 1.39\n* [xUnit Plugin](https://plugins.jenkins.io/xunit) - since 3.1.0\n* [Autograding Plugin](https://plugins.jenkins.io/autograding)\n\nImplementations:\n* [GitHub Checks Plugin](https://plugins.jenkins.io/github-checks)\n* [Gitea Checks Plugin](https://plugins.jenkins.io/gitea-checks/)\n\nThis plugin, along with its [GitHub implementation](https://plugins.jenkins.io/github-checks), has been installed on [ci.jenkins.io](https://ci.jenkins.io/Plugins) to help maintain over 1500 Jenkins plugins. You can take a look at the [action](https://github.com/jenkinsci/checks-api-plugin/runs/1025532156) for this repository or other plugin repositories under [Jenkins organization](https://github.com/jenkinsci) for the results.\n\n## Embedded Features\n\n### Build Status Check\n\n![GitHub Status](docs/images/github-status.png)\n\nThis plugin defines extension points to publish statuses to different SCM platforms.\n\nIt depends on the implementation to decide whether to skip them and what name to use.\n\nIf enabled, the statuses will be published in different stages of a Jenkins build (enters the queue, checkout, and completes).\n\n### Pipeline Usage\n\n- publishChecks: you can publish checks directly in the pipeline script instead of depending on consumer plugins:\n\n```\npublishChecks name: 'example', title: 'Pipeline Check', summary: 'check through pipeline',\n    text: 'you can publish checks in pipeline script',\n    detailsURL: 'https://github.com/jenkinsci/checks-api-plugin#pipeline-usage',\n    actions: [[label:'an-user-request-action', description:'actions allow users to request pre-defined behaviours', identifier:'an unique identifier']]\n```\n\n*To use customized actions, you will need to write a Jenkins plugin.\nIf you want to add GitHub checks actions, which are basically buttons on the checks report,\nyou need to extend [GHEventSubscriber](https://github.com/jenkinsci/github-plugin/blob/master/src/main/java/org/jenkinsci/plugins/github/extension/GHEventsSubscriber.java) to handle the event,\nsee [the handler](https://github.com/jenkinsci/github-checks-plugin/blob/ea060be67dad522ab6c31444fc4274955ac6e918/src/main/java/io/jenkins/plugins/checks/github/CheckRunGHEventSubscriber.java) for re-run requests as an example.*\n\n- withChecks: you can inject the check's name into the closure for other steps to use:\n\n```groovy\nwithChecks('injected name') {\n    // some other steps that will extract the name\n}\n```\n\n`withChecks` will publish an in progress check immediately and then other consuming plugins will publish the final check.\n\nYou can also include the checks stage name with `includeStage`:\n\n```groovy\nwithChecks(name: 'Tests', includeStage: true) {\n    sh 'mvn -Dmaven.test.failure.ignore=true clean verify'\n    junit '**/target/surefire-reports/TEST-*.xml'\n}\n```\n\nCombining `includeStage` with the JUnit plugin works well to publish checks for each test suite:\n\n![With Checks multiple stages](docs/images/github-status.png)\n\n\u003cdetails\u003e\n\n\u003csummary\u003eExample full pipeline with parallel stages\u003c/summary\u003e\n\n```groovy\ndef axes = [\n        platforms: ['linux', 'windows'],\n        jdks: [17, 21],\n]\ndef builds = [:]\naxes.values().combinations {\n    def (platform, jdk) = it\n    builds[\"${platform}-jdk${jdk}\"] = {\n        node(platform) {\n            stage(\"${platform.capitalize()} - JDK ${jdk} - Test\") {\n                checkout scm\n                withChecks(name: 'Tests', includeStage: true) {\n                    sh 'mvn -Dmaven.test.failure.ignore=true clean verify'\n                    junit '**/target/surefire-reports/TEST-*.xml'\n                }\n            }\n        }\n    }\n}\n\nparallel builds\n```\n\n\u003c/details\u003e\n\n## Guides\n\n- [Consumers Guide](docs/consumers-guide.md)\n- [Implementation Guide](docs/implementation-guide.md)\n\n## Contributing\n\nRefer to our [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md)\n\n## Acknowledgements\n\nThis plugin was started as a [Google Summer of Code 2020 project](https://summerofcode.withgoogle.com/projects/#5139745388101632), special thanks to the support from [Jenkins GSoC SIG](https://www.jenkins.io/sigs/gsoc/) and the entire community.\n\n\n## LICENSE\n\nLicensed under MIT, see [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fchecks-api-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fchecks-api-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fchecks-api-plugin/lists"}