Skip to content

Commit d734a07

Browse files
committed
docs: expand QA starter kit workflow and local setup guidance
1 parent 4ef256d commit d734a07

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,21 @@ LOCAL_MASTER_ACCOUNT=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf
5555
NETWORK=<network-name> pnpm run test:e2e all
5656
```
5757

58+
## QA Starter Kit workflow
59+
60+
When you need to validate SDK integrations against backend or node features, lean on the [QA Starter Kit](https://github.com/LIT-Protocol/QA-kit). That repo installs published packages, so it mirrors how downstream teams will consume the SDK.
61+
62+
1. The node team opens a feature branch for their service.
63+
2. Create a matching SDK branch and build the integration for that node change.
64+
3. Publish a snapshot (prerelease) of the SDK packages so the QA Starter Kit can install them from npm.
65+
4. Point the QA Starter Kit to that snapshot to perform the e2e flow before promoting the release.
66+
67+
This keeps QA aligned with the packages that will actually ship and avoids the drift that comes with local linking.
68+
5869
# Running it against a local network
5970

71+
Generate a fresh `networkContext.json` for local nodes with `pnpm run gen:local-network-context` before running the e2e tests against the `naga-local` local network.
72+
6073
## Required Environment Variables
6174

6275
```bash
@@ -132,6 +145,18 @@ This command must be run manually and is NOT part of the build process, as it re
132145
DEV_BRANCH=develop GH_API_KEY=github_pat_xxx pnpm run sync:contracts
133146
```
134147

148+
## Keeping the docs changelog in sync with the public site
149+
150+
Use the `sync:docs-changelog` script to refresh the changelog that powers [naga.developer.litprotocol.com/changelog](https://naga.developer.litprotocol.com/changelog).
151+
152+
```shell
153+
pnpm run sync:docs-changelog
154+
```
155+
156+
> Note: we currently run this manually after the Changeset PR lands in the `naga` main branch, though we expect to automate it in CI in the future.
157+
158+
The script collates the latest entries from `packages/*/CHANGELOG.md` and rewrites the target `changelog.mdx`. Commit and publish the regenerated file in the docs repo so the public changelog stays current.
159+
135160
---
136161

137162
# Legacy Documentation for V7 and Earlier

0 commit comments

Comments
 (0)