Skip to content

Commit

Permalink
Tweak test scripts and update contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
askoufis committed May 15, 2024
1 parent 93a1ce3 commit e44e8e1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ jobs:
key: jest-${{ runner.os }}-${{ hashFiles('./pnpm-lock.yaml') }}

- name: Test
run: pnpm run test
run: pnpm run test && pnpm run test:sku-init
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ To run the test suite locally:
pnpm run test
```

> [!NOTE]
> The [`sku-init` test suite] is not run as part of the `test` script.
> The test is run separately as it can conflict with other tests running in parallel.
> It is always run on CI, but it can be run locally with `pnpm run test:sku-init`.
If snapshots are out of date, you can update them with:

```sh
Expand Down Expand Up @@ -84,6 +89,8 @@ Once you've made the desired changes and you're ready to commit, stage your loca
> Due to the inconsistent ordering of our test suite, dot files within the fixture directories can sometimes end up with changes.
> These changes should not be committed and can be safely discard.
[`sku-init` test suite]: ./fixtures/sku-init/sku-init.test.js

## Publishing a New Version

This repo uses [changesets] for publishing new versions.
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
"lint:prettier": "prettier --cache --list-different '**/*.{js,ts,tsx,md,less,css}'",
"lint:tsc": "tsc",
"check": "pnpm install --frozen-lockfile && echo 'Ignore paths from lint-staged'",
"test": "pnpm run test:rest && pnpm run test:sku-init",
"test:rest": "SKU_TELEMETRY=false SKU_DISABLE_CACHE=true OPEN_TAB=false jest --verbose",
"test": "SKU_TELEMETRY=false SKU_DISABLE_CACHE=true OPEN_TAB=false jest --verbose",
"test:sku-init": "SKU_TELEMETRY=false SKU_DISABLE_CACHE=true OPEN_TAB=false jest --verbose --config=jest.config.sku-init.js",
"setup-test-hosts": "node test-utils/setupTestHosts",
"format": "prettier --cache --write '**/*.{js,ts,tsx,md,less,css}' && eslint --cache --fix .",
Expand Down

0 comments on commit e44e8e1

Please sign in to comment.