actions / actions/toolkit

Is `exec.getExecOutput` public API?

Open
#1,267 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hi team 👋 I was wondering if the exec.getExecOutput function is a part of the @actions/exec API or if it's an internal function that shouldn't be used? I can see it's an exported function but it's not documented anywhere, nonetheless, it's really convenient. I discovered it by accident while I was looking at the source code. If it's a part of the public API and safe to use I would expect it to be documented. Thanks!

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

Review the exported getExecOutput function in the @actions/exec source and check the existing package documentation. Confirm with maintainers whether it is supported public API; done means its status is clearly documented, or the issue is answered if it should remain internal.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.