Migrate to ESM

[MikeMcC399]

What would you like?

Migrate this repo from CommonJS to ESM, currently

github-action/package.json

Line 36 in e0f7da8

"type": "commonjs",

Why is this needed?

Key dependencies in this repo have moved or will move to ESM, for example:

• GitHub Actions toolkit @actions/* modules are expected to move have moved to ESM soon

• got is locked at 11.8.6 because got@>=12 is native ESM.

  Got v11 is no longer maintained and we will not accept any backport requests.

  Edit: this is resolved through PR fix: migrate from got@11 to got@16 #1874

[MikeMcC399]

I don't expect to be doing this myself and it will probably fall to the Cypress.io team if it is to be done. In the long term, if it is not addressed then the action will tend to become unmaintainable. The got dependency version used is already unmaintained. Edit: resolved.

[MikeMcC399]

For example @actions/core@3.0.0 says:

• Breaking change: Package is now ESM-only
• CommonJS consumers must use dynamic import() instead of require()

Attempting to update the action to this version fails at the build stage if no other changes are made:

$ npm run build

> @cypress/github-action@0.0.0-development build
> ncc build -o dist index.js

ncc: Version 0.38.4
ncc: Compiling file index.js into CJS
Error: Module not found: Error: Package path . is not exported from package <repo-root>/github-action/node_modules/@actions/core (see exports field in <repo-root>/github-action/node_modules/@actions/core/package.json)

[MikeMcC399]

• test: update examples to type: module (ESM) #1672 migrates the examples only

[MikeMcC399]

• PR fix: migrate from got@11 to got@16 #1874 fixes the got issue and migrates to the latest ESM version.