Skip to content

Commit b3d7dbf

Browse files
committed
update CI pipelines and contributing doc
1 parent 4c30c3b commit b3d7dbf

File tree

6 files changed

+21
-22
lines changed

6 files changed

+21
-22
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Hello! Thanks for contributing to Zedux. Read this message and delete it to ackn
44

55
Make sure you've followed the [contribution guidelines](https://github.com/Omnistac/zedux/blob/master/CONTRIBUTING.md). Specifically:
66

7-
- Make sure the first commit is formatted correctly (via running `yarn commit` in the repo root) and indicates all affected packages.
7+
- Make sure the first commit is formatted correctly (via running `pnpm commit` in the repo root) and indicates all affected packages.
88

99
We'll use this to generate the changelog and release notes if your PR is merged. Any other commits will be squashed into the first commit. Each PR can only have one commit, so separate changes into separate PRs if needed.
1010

.github/workflows/coverage.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ jobs:
1515
uses: actions/setup-node@v4
1616
with:
1717
node-version: '20.x'
18-
- run: yarn --frozen-lockfile
19-
- run: yarn build
20-
- run: yarn test
18+
- name: Install pnpm
19+
uses: pnpm/action-setup@v4
20+
- run: pnpm i --frozen-lockfile
21+
- run: pnpm build
22+
- run: pnpm test
2123
- name: Upload Coverage to Codecov
2224
uses: codecov/codecov-action@v5
2325
with:

.github/workflows/test.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ jobs:
2121
uses: actions/setup-node@v4
2222
with:
2323
node-version: ${{ matrix.node-version }}
24-
- run: yarn --frozen-lockfile
25-
- run: yarn build
26-
- run: yarn test
24+
- name: Install pnpm
25+
uses: pnpm/action-setup@v4
26+
- run: pnpm i --frozen-lockfile
27+
- run: pnpm build
28+
- run: pnpm test

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,3 @@
77
coverage
88
dist
99
node_modules
10-
yarn-debug.log*
11-
yarn-error.log*

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ Abide by the [code of conduct](CODE_OF_CONDUCT.md).
22

33
## Starting Development
44

5-
We use `yarn` to manage package dependencies. Simply running `yarn` in the repo root is all you need to get started with developing the packages.
5+
We use `pnpm` to manage package dependencies. Simply running `pnpm i` in the repo root is all you need to get started with developing the packages.
66

7-
We use Nx with yarn workspaces to manage the package-based monorepo. Every directory in the `packages/` folder is its own npm package. Run `yarn nx graph` to see the dependency graph of Zedux packages.
7+
We use Nx with pnpm workspaces to manage the package-based monorepo. Every directory in the `packages/` folder is its own npm package. Run `pnpm nx graph` to see the dependency graph of Zedux packages.
88

9-
We recommend Test-Driven Development for most Zedux code changes. Add integration tests and run `yarn test my-test-file` in the repo root to check changes.
9+
We recommend Test-Driven Development for most Zedux code changes. Add integration tests and run `pnpm run test my-test-file` in the repo root to check changes.
1010

1111
### Docs
1212

13-
The docs are separated from the rest of the repo - they're not a yarn workspace. To run the docs site:
13+
The docs are separated from the rest of the repo - they're not a pnpm workspace. To run the docs site:
1414

1515
```sh
1616
cd docs
17-
yarn
18-
yarn start
17+
pnpm i
18+
pnpm start
1919
```
2020

2121
This sets up an HMR-enabled dev server for quickly previewing docs site changes.
@@ -28,7 +28,7 @@ Properly type everything - no `any`s unless it's the correct type or you demonst
2828

2929
Add integration tests in the `test/integrations` folder of the appropriate package(s) to **fully** demonstrate all desired functionality. Unit tests aren't required if all functionality is covered well in integration tests, but they are a nice-to-have.
3030

31-
Ensure that all tests pass by running `yarn test` in the repo root. That command will also output code coverage. Ensure that all changes have full Statement, Branch, Function, and Line coverage.
31+
Ensure that all tests pass by running `pnpm test` in the repo root. That command will also output code coverage. Ensure that all changes have full Statement, Branch, Function, and Line coverage.
3232

3333
The PR title should be in the same format as the main commit. E.g. `feat(react): implement cool new thing`
3434

@@ -40,15 +40,15 @@ Make the PR directly against Zedux `master` branch unless it's a hotfix for a sp
4040

4141
If your PR can't be merged due to conflicts, rebase against Zedux master, resolve conflicts locally, and force push the changes.
4242

43-
If your PR requires changes, you can push those as separate commits (only the first commit has to follow the [commit message guidelines](#commit-messages) via `yarn commit`. All other commits can be free-form via `git commit`). Or you can `git commit --amend` a previous commit and force push.
43+
If your PR requires changes, you can push those as separate commits (only the first commit has to follow the [commit message guidelines](#commit-messages) via `pnpm commit`. All other commits can be free-form via `git commit`). Or you can `git commit --amend` a previous commit and force push.
4444

4545
## Commit Messages
4646

4747
We use a custom script to generate the CHANGELOG from commit messages. Thus commit messages must follow a specific format. This format is a simplification of the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
4848

49-
Use `yarn commit` (in the repo root) instead of `git commit` to make our custom commit formatter tool automatically format these correctly for you.
49+
Use `pnpm commit` (in the repo root) instead of `git commit` to make our custom commit formatter tool automatically format these correctly for you.
5050

51-
It's recommended to always use `yarn commit`, but if you want to know the format that it outputs, here it is:
51+
It's recommended to always use `pnpm commit`, but if you want to know the format that it outputs, here it is:
5252

5353
```
5454
<type>(<optional scope>): <description>

examples/socket-io/.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
logs
33
*.log
44
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
75
pnpm-debug.log*
8-
lerna-debug.log*
96

107
node_modules
118
dist

0 commit comments

Comments
 (0)