Create a check run

POST

/repos/{owner}/{repo}/check-runs

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///check-runs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "actions": [
        {
            "description": "Allow us to fix these errors for you",
            "identifier": "fix_errors",
            "label": "Fix"
        }
    ],
    "completed_at": "2017-11-30T19:49:10Z",
    "conclusion": "success",
    "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
    "name": "mighty_readme",
    "output": {
        "annotations": [
            {
                "annotation_level": "warning",
                "end_line": 2,
                "message": "Check your spelling for '\''banaas'\''.",
                "path": "README.md",
                "raw_details": "Do you mean '\''bananas'\'' or '\''banana'\''?",
                "start_line": 2,
                "title": "Spell Checker"
            },
            {
                "annotation_level": "warning",
                "end_line": 4,
                "message": "Check your spelling for '\''aples'\''",
                "path": "README.md",
                "raw_details": "Do you mean '\''apples'\'' or '\''Naples'\''",
                "start_line": 4,
                "title": "Spell Checker"
            }
        ],
        "images": [
            {
                "alt": "Super bananas",
                "image_url": "http://example.com/images/42"
            }
        ],
        "summary": "There are 0 failures, 2 warnings, and 1 notices.",
        "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
        "title": "Mighty Readme report"
    },
    "started_at": "2017-11-30T19:39:10Z",
    "status": "completed"
}'