actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

summary: consistent kB usage and doc links

pull/1014/head
Rob Herley 2022-03-03 11:46:32 -05:00
parent 339dd63bec
commit 6295f5d25b
No known key found for this signature in database
GPG Key ID: D1602042C3543B06
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
packages/core/src/markdown-summary.ts
View File

@ -2,8 +2,11 @@ import {EOL} from 'os'
import {constants, promises} from 'fs' import {constants, promises} from 'fs'
const {access, appendFile, stat, writeFile} = promises const {access, appendFile, stat, writeFile} = promises
export const SUMMARY_LIMIT_BYTES = 128_000 // The runner & server will also block any upload greater than this size
export const SUMMARY_LIMIT_BYTES = 128 * 1024
export const SUMMARY_ENV_VAR = 'GITHUB_STEP_SUMMARY' export const SUMMARY_ENV_VAR = 'GITHUB_STEP_SUMMARY'
export const SUMMARY_DOCS_URL =
'https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-markdown-summary'
export type SummaryTableRow = (SummaryTableCell | string)[] export type SummaryTableRow = (SummaryTableCell | string)[]
@ -140,9 +143,9 @@ class MarkdownSummary {
if (await this.willExceedLimit(overwrite)) { if (await this.willExceedLimit(overwrite)) {
this.emptyBuffer() this.emptyBuffer()
const limitK = SUMMARY_LIMIT_BYTES / 1000 const limitK = SUMMARY_LIMIT_BYTES / 1024
throw new Error( throw new Error(
`Aborting write to summary file. File size would exceed limit of ${limitK}K.` `Aborting write to summary file. File size would exceed limit of ${limitK}k. For more information see: ${SUMMARY_DOCS_URL}`
) )
} }