nodejs / nodejs/citgm

Use pkgjs/action for CI to auto-upgrade to latest nodes

Open
#891 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
606
Forks
157
Avg merge
3d 23h
Merged PRs (30d)
3

Description

The CI workflow used here is almost identical to a standard Node.js library testing pattern (checkout, npm install, npm test).

As part of Package Maintenance WG, I've recently created pkgjs/action - it basically does that standard Node testing pattern, but it automatically maintains the test matrix for you, i.e. it will automatically detect the lowest supported (major) version from engines field and will automatically add new Node.js versions as they come out.

As the action is pretty new, I'd like to get some battle testing for it.

Would people mind if I opened a PR to start using it here? I'm willing to take on the maintenance of that until we feel it's stable.

The end result here would probably look something like this: https://github.com/nodejs/undici/blob/main/.github/workflows/nodejs.yml

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 .github/workflows/nodejs.yml and compare it with the linked undici workflow, then read the pkgjs/action documentation to understand its expected configuration. Done means the citgm workflow uses pkgjs/action and automatically covers the supported and newly released Node.js versions without losing the existing test steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, javascript, nodejs
Domain
ci-cd, testing-qa
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.