actions / actions/toolkit

Be able to update group name

Open
#950 1 comment 1 reaction 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
The enhancement would be to be able to update the name passed as a parameter to core.startGroup function, before the core.endGroup is called. I don't know how difficult it is to do though.

Where does this need come from?

I use groups to gather logs about repetitive asynchronous tasks on different on list of objects.
At the end, I can see X groups corresponding to tasks on each objects such as Check this on object 1.
Today, a state (success/fail/nothing_to_do) for each task is logged inside each corresponding group. Since I have tens of tasks, it would be way more efficient to update the group name so I do not have to open all the groups to check how it went.

Example:

Initial group name:
initial_group_name

Call (regarding the semantic, I don't have any strong opinion on it):
core.setGroupName(core.getGroupName()+ ": SUCCESS")

Final group name:
final_group_name

ℹ️ I could also log a concise report at the end of all the group(tasks) if this feature is not doable.

Have a good day.

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 reading the core.startGroup and core.endGroup entry points and trace how the active group name is stored. Check whether existing tests cover group lifecycle or naming behavior. Done means callers can change the current group name before core.endGroup and the final displayed group uses the updated name.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.