actions / actions/toolkit

Export `issue` and `issueCommand` from `core`

Open
#853 0 comments 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 core package defines the very useful issueCommand and issue functions, however these are currently available for internal use only.

Code Snippet
Exporting these would allow common usage scenarios such as

core.info(`::add-matcher::${Path.join(some_base_path, 'foo.json')}`)

(or worse)

To be more cleanly expressed as

core.issue('add-matcher', Path.join(some_base_path, 'foo.json'))

Additional information
This will also isolate usage from any changes to the underlying command structure (see #110), as well as ensuring any required escaping is applied.

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 issue and issueCommand definitions in packages/core/src/command.ts, then inspect how the core package exposes its public API. Done means both functions can be imported from core rather than accessed only internally; run the relevant core tests, if present, to verify the public export.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.