Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify check summary max length units #35252

Open
1 task done
AbrilRBS opened this issue Nov 11, 2024 · 4 comments
Open
1 task done

Clarify check summary max length units #35252

AbrilRBS opened this issue Nov 11, 2024 · 4 comments
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR

Comments

@AbrilRBS
Copy link

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

@AbrilRBS AbrilRBS added the content This issue or pull request belongs to the Docs Content team label Nov 11, 2024
Copy link

welcome bot commented Nov 11, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 11, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. and removed triage Do not begin working on this issue until triaged by the team labels Nov 11, 2024
@nguyenalex836
Copy link
Contributor

@AbrilRBS Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 12, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836
Copy link
Contributor

@AbrilRBS Hello! 👋 Thank you for your patience while our SME team reviewed 💛

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

They are in agreement ✨ I've added the help wanted label to this issue so that you, or anyone else, can open a PR to update the docs. Thank you for raising a flag on this!

@nguyenalex836 nguyenalex836 added help wanted Anyone is welcome to open a pull request to fix this issue SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue rest Content related to rest - overview. SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

No branches or pull requests

3 participants