Skip to main content

UpdateCheckRun​

Update automated checks

Path Parameters
  • owner required

    The owner of the repository, generally called "username". The name is not case-sensitive.

  • repo required

    repository name, the name is not case sensitive

Header Parameters
  • Authorization required

    Oauth2 token or private token (needs to start with Bearer plus a space)

Request Body
  • name string

    The name of the automated check. For example, "code-coverage".

  • head_sha string

    commit sha value

  • status string

    Status enumeration, the enumeration values ​​are: queued, in_progress, completed. Default value: queued

  • started_at string

    start time. Follows ISO 8601 time format: YYYY-MM-DDTHH:MM:SSZ

  • conclusion string

    This field is required if you pass the "completed_at" field or set the "status" field to "completed". This field expresses the final result of the automated check. , Note: Providing the "conclusion" field will automatically set the status parameter to "completed". Also it will not be possible to change "conclusion" to "stale", only platforms can be set to this value. Enumeration values: action_required, canceled, failure, neutral, success, skip, stale, timed_out

  • completed_at string

    end time. Follows ISO 8601 time format: YYYY-MM-DDTHH:MM:SSZ

  • action object

    Automated checks can accept various types of data in "output", including titles and summaries, and can optionally provide descriptive details about the run.

  • label string

    The text displayed on the button in the web UI. Maximum length is 20 characters.

  • description string

    A brief explanation of the purpose of action. Maximum length is 40 characters.

  • identifier string

    A comparison identifier for action on the integrated system. Maximum length is 20 characters.

  • output object

    Automated checks can accept various types of data in "output", including titles and summaries, and can optionally provide descriptive details about the run.

  • title string

    title

  • summary string

    Summary, supports Markdown format. Maximum length is 65535 characters.

  • text string

    detail, maximum length is 65535 characters

  • annotations object

    Attach the information you analyzed to specific lines of code. Corresponding annotations can be seen in the inspection and file changes tabs of subsequent change requests on the platform. The automated inspection API limits the number of annotations requested to a maximum of 50. If you want to create more than 50, you can send the request multiple times to add comments to the list of existing comments.

  • path string

    The path to the file to add the annotation to. For example: assets/css/main.css.

  • start_line int

    The starting line of the comment. Line numbers start from 1.

  • end_line int

    The end line of the comment.

  • start_column int

    The starting column of the annotation. Comments only support start_column and end_column on the same line. If the values ​​of start_line and end_line are different, this parameter is omitted. Column numbers start from 1.

  • end_column int

    Ending column of comments. Comments only support start_column and end_column on the same line. If the values ​​of start_line and end_line are different, this parameter is omitted.

  • annotation_level string

    The level of annotation, the enumeration values ​​are: notice, warning, failure

  • message string

    A short description of the line of code information. Maximum size is 64kb.

  • title string

    Title of the comment. Maximum length is 255 characters.

  • raw_details string

    Details of the comment. Maximum size is 64kb.

  • images object

    Add images in CR UI.

  • alt string

    Alt text for the image.

  • image_url string

    The full URL of the image.

  • caption string

    Short image description.

Responses

success

Loading...
Last updated on