MCPcopy Index your code
hub / github.com/PyGithub/PyGithub / create_check_run

Method create_check_run

github/Repository.py:4177–4238  ·  view source on GitHub ↗

:calls: `POST /repos/{owner}/{repo}/check-runs `_ :param name: string :param head_sha: string :param details_url: string :param external_id: string :param status: string :par

(
        self,
        name: str,
        head_sha: str,
        details_url: Opt[str] = NotSet,
        external_id: Opt[str] = NotSet,
        status: Opt[str] = NotSet,
        started_at: Opt[datetime] = NotSet,
        conclusion: Opt[str] = NotSet,
        completed_at: Opt[datetime] = NotSet,
        output: Opt[dict[str, str | list[dict[str, str | int]]]] = NotSet,
        actions: Opt[list[dict[str, str]]] = NotSet,
    )

Source from the content-addressed store, hash-verified

4175 return github.GitReleaseAsset.GitReleaseAsset(self._requester, url=url)
4176
4177 def create_check_run(
4178 self,
4179 name: str,
4180 head_sha: str,
4181 details_url: Opt[str] = NotSet,
4182 external_id: Opt[str] = NotSet,
4183 status: Opt[str] = NotSet,
4184 started_at: Opt[datetime] = NotSet,
4185 conclusion: Opt[str] = NotSet,
4186 completed_at: Opt[datetime] = NotSet,
4187 output: Opt[dict[str, str | list[dict[str, str | int]]]] = NotSet,
4188 actions: Opt[list[dict[str, str]]] = NotSet,
4189 ) -> CheckRun:
4190 """
4191 :calls: `POST /repos/{owner}/{repo}/check-runs <https://docs.github.com/en/rest/reference/checks#create-a-check-run>`_
4192 :param name: string
4193 :param head_sha: string
4194 :param details_url: string
4195 :param external_id: string
4196 :param status: string
4197 :param started_at: datetime
4198 :param conclusion: string
4199 :param completed_at: datetime
4200 :param output: dict
4201 :param actions: list of dict
4202 :rtype: :class:`github.CheckRun.CheckRun`
4203 """
4204 assert isinstance(name, str), name
4205 assert isinstance(head_sha, str), head_sha
4206 assert is_optional(details_url, str), details_url
4207 assert is_optional(external_id, str), external_id
4208 assert is_optional(status, str), status
4209 assert is_optional(started_at, datetime), started_at
4210 assert is_optional(conclusion, str), conclusion
4211 assert is_optional(completed_at, datetime), completed_at
4212 assert is_optional(output, dict), output
4213 assert is_optional_list(actions, dict), actions
4214
4215 post_parameters = NotSet.remove_unset_items(
4216 {
4217 "name": name,
4218 "head_sha": head_sha,
4219 "details_url": details_url,
4220 "external_id": external_id,
4221 "status": status,
4222 "conclusion": conclusion,
4223 "output": output,
4224 "actions": actions,
4225 }
4226 )
4227
4228 if is_defined(started_at):
4229 post_parameters["started_at"] = started_at.strftime("%Y-%m-%dT%H:%M:%SZ")
4230 if is_defined(completed_at):
4231 post_parameters["completed_at"] = completed_at.strftime("%Y-%m-%dT%H:%M:%SZ")
4232
4233 headers, data = self._requester.requestJsonAndCheck(
4234 "POST",

Calls 5

is_optionalFunction · 0.90
is_optional_listFunction · 0.90
is_definedFunction · 0.90
remove_unset_itemsMethod · 0.80
requestJsonAndCheckMethod · 0.80

Tested by

no test coverage detected