actions / actions/toolkit

Please document the HTTP endpoints used by toolkit/packages/artifact

Open
#648 0 comments 0 reactions 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
Your upload-artifact looks too bad. It is too monstrous and relies on node.js. I wanna write an own much simpler implementation of it rather than using your one.

It would be nice to have the following information about it:

  1. docs to HTTP endpoints used
  2. a capture of an example conversation in HAR format

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 in toolkit/packages/artifact and trace the upload implementation to identify the HTTP calls it makes. Document those HTTP endpoints and include a representative example conversation in HAR format; the work is done when both requested artifacts are available for someone implementing a simpler client.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.