Skip to content

Clarify check summary max length units #35252

Closed as not planned
Closed as not planned
@AbrilRBS

Description

@AbrilRBS

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/checks/runs

What part(s) of the article would you like to see updated?

When the documentation for the output.summary content describes said field, it says:

The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.

The issue here comes when we used quite a few emojis in the output, our internal checks where checking character length of the output, which reported less than the maximum, but when trying to submit it, we got the error:

Response: {"message":"Validation Failed","errors":[{"resource":"CheckRun","code":"custom","field":"summary","message":"summary exceeds a maximum bytesize of 65535"}],"documentation_url":"https://docs.github.com/rest/checks/runs#create-a-check-run","status":"422"}

So it seems like the actual check is done in bytes, not characters

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    SME reviewedAn SME has reviewed this issue/PRcontentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issuerestContent related to rest - overview.staleThere is no recent activity on this issue or pull request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions