From 6295f5d25bb8417c8705fd29b31ce4f3bb743302 Mon Sep 17 00:00:00 2001 From: Rob Herley Date: Thu, 3 Mar 2022 11:46:32 -0500 Subject: [PATCH] summary: consistent kB usage and doc links --- packages/core/src/markdown-summary.ts | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/packages/core/src/markdown-summary.ts b/packages/core/src/markdown-summary.ts index 6a4ae9f9..b2880e90 100644 --- a/packages/core/src/markdown-summary.ts +++ b/packages/core/src/markdown-summary.ts @@ -2,8 +2,11 @@ import {EOL} from 'os' import {constants, promises} from 'fs' 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_DOCS_URL = + 'https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-markdown-summary' export type SummaryTableRow = (SummaryTableCell | string)[] @@ -140,9 +143,9 @@ class MarkdownSummary { if (await this.willExceedLimit(overwrite)) { this.emptyBuffer() - const limitK = SUMMARY_LIMIT_BYTES / 1000 + const limitK = SUMMARY_LIMIT_BYTES / 1024 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}` ) }