Refactor CI workflow for dependency installation#215
Refactor CI workflow for dependency installation#215mubking wants to merge 1 commit intoLabsCrypt:mainfrom
Conversation
Updated CI workflow to use 'npm install --ignore-scripts' instead of 'npm ci' for both frontend and backend. Removed caching for npm dependencies.
ogazboiz
left a comment
There was a problem hiding this comment.
hey @mubking, thanks for the iteration!
similar to my comment on the previous PR, changing to npm install --ignore-scripts and removing caching isn't the ideal fix, as npm ci ensures a clean, deterministic build and caching heavily speeds up our pipelines.
the original error happened because the runner couldn't find the package-lock.json files at the specified paths. could you revert the npm install change and instead ensure the cache-dependency-path correctly points to where our lockfiles actually live?
let me know if you need help with it! if you want to contribute more or follow up if issues are open, join us on Telegram: https://t.me/+DOylgFv1jyJlNzM0
ogazboiz
left a comment
There was a problem hiding this comment.
hey, thanks for the contribution!
To ensure your Pull Request passes the CI pipeline and maintains repository stability, please follow these technical requirements:
1. Backend Testing (Vitest)
- Version: We have standardized on Vitest
^2.1.8. Do not upgrade to v3 or v4 without explicit approval, as they introduce native dependency issues in the CI environment. - Isolation: Each test file now runs in its own forked process (
pool: 'forks'). This preventsvi.mock()and other module-level states from leaking between files. - Prisma Mocking: When testing controllers, always mock the Prisma client in
backend/src/lib/prisma.ts. Do not rely on a real database for unit tests. - CLI Flags: Avoid using the
--verboseflag in Vitest commands, as it is incompatible with the v2 CLI.
2. API Versioning & Routing
- Endpoints: Hit versioned endpoints (e.g.,
/v1/streams) instead of the deprecated root endpoints (e.g.,/streams). - Response Codes: Endpoints return
410 Gonefor specifically deprecated routes. Ensure your tests handle these correctly. - Input Validation: Controllers expect strict field names (e.g.,
streamId,ratePerSecond,depositedAmount). Use the types defined insrc/services/andsrc/controllers/.
3. Infrastructure & Dependencies
- Husky: The pipeline skips Husky. Your
package.jsonscripts should usehusky || trueto prevent non-interactive shell failures. - Prisma Generation: Always ensure your workflow runs
prisma generatebefore tests. The CI now handles this in a consolidated "Setup Database" step. - Native Bindings: If you add dependencies with native bindings (like Rollup or ESBuild), ensure they are compatible with the
ubuntu-latest(linux-x64) runner.
4. Frontend Best Practices
- Directives: Always include
"use client"at the top of components that utilize React hooks or browser APIs. - Dependencies: Ensure all utilized libraries (like
react-hot-toast) are explicitly added tofrontend/package.jsonand not just inherited from the root.
Please make sure your CI passes before we finalize the merge. Let us know if you have any questions!
If you want to follow up or have questions, join us on Telegram: https://t.me/+DOylgFv1jyJlNzM0
ogazboiz
left a comment
There was a problem hiding this comment.
hey, just checking in on this again — still waiting on those updates to fix the CI based on our last comment. no rush if you're busy, just let us know if you plan to continue with it or if we should close it for now!
if you want to contribute more or follow up if issues are open, join us on Telegram: https://t.me/+DOylgFv1jyJlNzM0
|
closing due to inactivity — feel free to reopen when you're ready to continue! |
Updated CI workflow to use 'npm install --ignore-scripts' instead of 'npm ci' for both frontend and backend. Removed caching for npm dependencies.
Description
Type of Change
Related Issues
Closes #
Changes Made
Testing
Test Coverage
Test Steps
Breaking Changes
Breaking Changes:
Migration Guide:
Screenshots/Demo
Checklist
Additional Notes