ci setup
Some checks failed
CI / lint-typecheck (pull_request) Failing after 4m51s
CI / tests (pull_request) Has been skipped
CI / contract-tests (pull_request) Has been skipped
CI / e2e-tests (pull_request) Has been skipped
CI / comment-pr (pull_request) Has been skipped
CI / commit-types (pull_request) Has been skipped
Some checks failed
CI / lint-typecheck (pull_request) Failing after 4m51s
CI / tests (pull_request) Has been skipped
CI / contract-tests (pull_request) Has been skipped
CI / e2e-tests (pull_request) Has been skipped
CI / comment-pr (pull_request) Has been skipped
CI / commit-types (pull_request) Has been skipped
This commit is contained in:
28
README.md
28
README.md
@@ -56,7 +56,7 @@ npm test
|
||||
Individual applications support hot reload and watch mode during development:
|
||||
|
||||
- **web-api**: Backend REST API server
|
||||
- **web-client**: Frontend React application
|
||||
- **web-client**: Frontend React application
|
||||
- **companion**: Desktop companion application
|
||||
|
||||
## Testing Commands
|
||||
@@ -64,12 +64,28 @@ Individual applications support hot reload and watch mode during development:
|
||||
GridPilot follows strict BDD (Behavior-Driven Development) with comprehensive test coverage.
|
||||
|
||||
### Local Verification Pipeline
|
||||
Run this sequence before pushing to ensure correctness:
|
||||
```bash
|
||||
npm run lint && npm run typecheck && npm run test:unit && npm run test:integration
|
||||
```
|
||||
|
||||
GridPilot uses **lint-staged** to automatically validate only changed files on commit:
|
||||
|
||||
- `eslint --fix` runs on changed JS/TS/TSX files
|
||||
- `vitest related --run` runs tests related to changed files
|
||||
- `prettier --write` formats JSON, MD, and YAML files
|
||||
|
||||
This ensures fast commits without running the full test suite.
|
||||
|
||||
### Pre-Push Hook
|
||||
|
||||
A **pre-push hook** runs the full verification pipeline before pushing to remote:
|
||||
|
||||
- `npm run lint` - Check for linting errors
|
||||
- `npm run typecheck` - Verify TypeScript types
|
||||
- `npm run test:unit` - Run unit tests
|
||||
- `npm run test:integration` - Run integration tests
|
||||
|
||||
You can skip this with `git push --no-verify` if needed.
|
||||
|
||||
### Individual Commands
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
npm test
|
||||
@@ -147,4 +163,4 @@ Comprehensive documentation is available in the [`/docs`](docs/) directory:
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
MIT License - see [LICENSE](LICENSE) file for details.
|
||||
|
||||
Reference in New Issue
Block a user