ci: add GitHub Actions workflow for the unit test suite - #46
Merged
Conversation
Run npm test on pull requests and pushes to main across current Node LTS releases so regressions are caught before merge. Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
@readmeio/git-format lists the darwin-only fsevents package as a required dependency, which makes a plain npm ci fail on Ubuntu. Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Without --add, the second insteadOf assignment overwrites the first, so the lockfile's ssh://git@github.com/ mapping is dropped. Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
The lockfile was still on 4806df45, whose package.json listed a flattened node_modules tree including darwin-only fsevents. Point the dependency at git+https://github.com/readmeio/git-format.git (current main, f7d72069) and drop the CI --force / SSH URL rewrites that were only needed for that old commit. Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
Raise engines.node from >=18 to >=22 and test CI against 22, current LTS, and latest. Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
erunion
marked this pull request as ready for review
August 27, 2026 17:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🧰 Changes
Adds
.github/workflows/ci.ymlso pull requests and pushes tomainrun the unit test suite (npm test).The workflow:
package-lock.jsonwithnpm ciactions/setup-nodeRaises
engines.nodefrom>=18to>=22.Also updates
@readmeio/git-formatto currentmain(git+https://github.com/readmeio/git-format.git,f7d72069). The lockfile was still pinned to4806df45, whosepackage.jsonlisted a flattenednode_modulestree.Permissions are limited to
contents: read. In-progress runs for the same ref are cancelled when a newer commit is pushed.🧬 QA & Testing
npm cithennpm test— 131/131 passed22,lts/*, andlateston this PR