actions / actions/toolkit

Plan for transition to ESM?

Open
#1,770 1 comment 21 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

@octokit/core and friends are now ESM-only. The packages here that use them, like @actions/github, are still on the previous major version of @octokit/core (which uses CommonJS).

Presumably the @actions/* packages will need to switch to the new versions eventually to keep up with new features, fixes, API endpoints, and so on. What's the plan for doing so? Is this project looking for community help with that work?

ESM-only can be a reasonably disruptive change. Since the official @octokit/* packages are moving in that direction, I'll assume GitHub has already discussed this internally and decided that this work is work the risks and disruption to users.

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 with @actions/github and the other @actions packages that depend on @octokit/core, then review how their current CommonJS dependency versions are configured. Compare the ESM-only transition requirements and document a migration plan, including compatibility risks and whether community help is appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.