Emitting inline backticks with core.summary does not render code elements
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.9k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
I'm trying to print some paragraph text, including inline code snippets (not code blocks).
eg
Bumping formula `something` in `custom/tap` to `v1.2.3`.
which should render on the summary as:
To Reproduce
Steps to reproduce the behavior:
Printing to summary file:
import { summary } from '@actions/core'
summary.addRaw(`Bumping formula \`${formulaName}\` in \`${owner}/${repo}\` to \`${tagName}\`. `)
When run in a workflow, the resulting summary instead contains literal backticks.
Expected behavior
I would expect the inline code backticks to be escaped by the JS template literal and thus passed to github's markdown renderer directly, thus rendering as <code> elements.
Screenshots
Desktop (please complete the following information):
- OS: macos
- Browser safari
- Version 18.5
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the @actions/core summary.addRaw entry point and reproduce the workflow example that writes inline backticks to the summary. Verify the resulting GitHub summary renders the inline snippets as code elements instead of literal backticks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100