actions / actions/toolkit

actions/exec: Allow timeout on running a process

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

If your issue is relevant to this repository, please include the information below:

Describe the enhancement

Currently actions/exec's exec function does not allow timeout. So, when the command being run by the function hangs, the CI workflow will wait until the workflow is timed out. Setting timeout is useful to avoid this problem.

So please consider to allow timeout on running process with the function.

Code Snippet

await exec('some-command', ['some', 'args'], {
  timeout: 1000, // 1 second timeout
}) 

Additional information

Nothing.

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

Locate the actions/exec exec function and read how its options are handled when running a process. Check the existing tests around this entry point, if present. Done means the API accepts the shown timeout option and a hanging command is stopped after the configured interval.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.