actions / actions/toolkit

@actions/core: Add support for full width tables and column width

Open
#1,766 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the enhancement

With the core.summary.addTable, we can already add a table to the job summary, but we have no control over how the outcome of the table would be. It would be useful to be able to tell if it should be a full width table and defining the column widths would make it perfect.

Code Snippet

// Define full width on the table
core.summary.addTable(tableRows, { fullWidth: true });

// Define the width on the table rows/headers
const tableRows = [
	[
		{ data: "title", header: true, width: "20%" },
		{ data: "description", header: true, width: "60%" },
		{ data: "outcome", header: true, width: "20%" },
	]
]

Additional information

For more context, I use the https://www.npmjs.com/package/@estruyf/github-actions-reporter dependency in my Playwright tests to report the test outcomes. Right now, each of the test result tables has its own width, depending on the text inserted into it.

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the TypeScript implementation and tests for core.summary.addTable. Trace how table options and cell data are rendered, then define support for full-width tables and column widths; done when both options produce the requested summary layout and tests cover them.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.