actions / actions/toolkit

uploadReleaseAsset has incomplete type for data

Open
#1,401 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug
uploadReleaseAsset has incomplete type for data parameter (missing Buffer type)

To Reproduce
Steps to reproduce the behavior:

use with strict type checking rules

uploadReleaseAsset({data: fs.readFileSync('some_file'), ...});

Expected behavior
code passes type checker for data parameter

Desktop (please complete the following information):
node16
typescript 5.0
@actions/github 5.1.1

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 TypeScript declaration or entry point for uploadReleaseAsset and inspect the data parameter type. Reproduce the strict-checking example with Node 16 and TypeScript 5.0, then verify that the fs.readFileSync result is accepted as a Buffer.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.