actions / actions/toolkit

Using core.summary.addList([]) should be a no-op, instead it's broken HTML

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

Nobody has claimed this yet.

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

Description

Describe the bug

To Reproduce
Steps to reproduce the behavior:

  1. Use core.summary.addList([])
  2. Call core.summary.stringify
  3. Observe an un-closed ul tag is added to the summary contents:

Here is an example from my test suite where I happen to hit the case,

      <h1>:heavy_check_mark: statsd/statsd passed all policies</h1>
    + <ul>
      <a href="https://app.wiz.io/reports/cicd-scans#~(cicd_scan~'abc123)">View report on Wiz</a>
      ↵

Expected behavior
This should do nothing, add no content to the summary buffer.

Alternatively, adding an empty element, <ul></ul> could work.

Screenshots

Desktop (please complete the following information):

  • OS: Arch
  • Browser N/A
  • Version node20

Smartphone (please complete the following information):
N/A

Additional context

% grep '@actions/core' yarn.lock
"@actions/core@^1.10.1", "@actions/core@^1.2.6", "@actions/core@^1.9.1":
  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.10.1.tgz#61108e7ac40acae95ee36da074fa5850ca4ced8a"
    "@actions/core" "^1.9.1"
    "@actions/core" "^1.2.6"

It's possible an un-closed ul tag is acceptable wherever you render this HTML, I tried to find a general answer and at least this says it must be closed.

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 at the core.summary.addList entry point and reproduce the issue by passing an empty array, then calling core.summary.stringify. Verify the current output and adjust the behavior so an empty list adds no content, or produces only a closed empty ul element; confirm the resulting HTML is valid.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.