actions / actions/toolkit

Allow AnnotationProperties parameter with core.setFailed method

Open
#1,091 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

Hi!

Now it is not possible to set error title with setFailed method.

Since the setFailed method uses error method internally, might it be possible to add a properties parameter to the setFailed method?

try {
  await doSomething();
}
catch (error: any) {
  core.setFailed(error, { title: 'Some error title.' });
}

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 of core.setFailed and the error method it uses. Review any nearby tests or callers, then verify that setFailed accepts the requested properties and that the title reaches the resulting error annotation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.