-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add workflow that tests if tarball is installable
- Loading branch information
1 parent
d49ee2d
commit 928f67c
Showing
3 changed files
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: NPM pack check | ||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
jobs: | ||
npm-pack-check: | ||
runs-on: ubuntu-latest | ||
# Only run this job if the PR is from a trusted collaborator (i.e. not a fork) | ||
if: github.event.pull_request.head.repo.full_name == github.repository | ||
steps: | ||
# Checkout project repository | ||
- name: Checkout | ||
uses: actions/[email protected] | ||
|
||
# Setup Node.js environment | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
registry-url: https://registry.npmjs.org/ | ||
node-version: 20 | ||
|
||
# Install dependencies so that prepublish scripts work as expected | ||
- name: Install deps | ||
run: npm i | ||
|
||
- name: Build package | ||
run: npm run build | ||
|
||
- name: Create test install directory | ||
run: mkdir ../test-install | ||
|
||
# Pack the package and move it to the test install directory, then | ||
# install it and ensure that it can be "required" | ||
- name: Ensure pack file can be installed | ||
run: | | ||
export PACK_FILENAME=$(npm pack --json | jq -r '.[] | .filename') | ||
mv $PACK_FILENAME ../test-install/ | ||
mv test/npm-pack.js ../test-install/ | ||
cd ../test-install | ||
npm install $PACK_FILENAME | ||
node npm-pack.js |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,7 +20,7 @@ jobs: | |
uses: actions/setup-node@v3 | ||
with: | ||
registry-url: https://registry.npmjs.org/ | ||
node-version: 16 | ||
node-version: 20 | ||
|
||
# Use a cache for dependencies | ||
- uses: actions/[email protected] | ||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
/** | ||
* This is a simple test script that checks that the package can be required and | ||
* that the setup export is defined. | ||
* This script is used in the `npm-pack-check` GitHub workflow. | ||
*/ | ||
const yates = require("@cerebruminc/yates"); | ||
|
||
if (typeof yates.setup === "undefined") { | ||
throw new Error("setup export is undefined"); | ||
} | ||
|
||
console.log("Success!"); |