Skip to content

Checks API output text limit #2403

New issue

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

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

Already on GitHub? # to your account

Closed
NasAmin opened this issue Dec 28, 2020 · 3 comments
Closed

Checks API output text limit #2403

NasAmin opened this issue Dec 28, 2020 · 3 comments
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team

Comments

@NasAmin
Copy link

NasAmin commented Dec 28, 2020

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/rest/reference/checks

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

The Creating a Check section describes the different parameters of creating the check. In particular, the Output --> text parameter. Recently, I become aware that the output.text is limited to 65k characters. Is this a hard limit?
What is the advice if we are providing a markup that exceeds the 65k limit?
If there is a hard limit on output.text then IMHO it should be in the documentation plus some advice if larger data is needed in this field. Can it be a blob instead of a text field?

Additional information

One might wonder why would you want to send so much data to a check output?
An example is reports for test results
An example of this could be creating a check for unit test results.

@welcome
Copy link

welcome bot commented Dec 28, 2020

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 Dec 28, 2020
@janiceilene
Copy link
Contributor

Thanks for opening an issue @NasAmin! I'll get this triaged for the team to take a look 👀

@janiceilene
Copy link
Contributor

Just noticed this is a duplicate of #3765! Closing this one in favor of the other one 😸

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team
Projects
None yet
Development

No branches or pull requests

3 participants
@janiceilene @NasAmin and others