Home

This document is PUBLIC. Please be careful.

Setup

Prerequisites

• Node.js
• Enable corepack by corepack enable

How to Run Tests

• Install dependencies: npm ci.
• Clean up built artifacts: npm run clean.
  • To avoid a complex cyclic problem, this does not remove .turbo/ (turborepo's cache files) due to this clean script is also invoked by turborepo.
  • Clean up turborepo's cache files (.turbo/): e.g. find . -name ".turbo" -type d -prune | xargs -p rm -rf.
• Check type integrity: npm run typecheck.
• Run unit tests: npm run test.
  • Run unit tests with updating snapshots: npm run test:update_snapshots.
• Run lint: npm run lint.
  • Fix autofixable lint problems: npm run lint:fix.
• Check code format: npm run format:check.
  • Apply code format: npm run format.

Release Engineering

How to Release

1. Bump version defined in package.json.
   • To create a change, npm version <version> --no-git-tag-version --workspace ./packages/http-helper is useful.
2. Land a commit including the change by step 1 into main branch.
3. Create a new release from "Releases".
   • Should create a version tag
   • A version tag should be v<major>.<minor>.<patch> format.
4. Check to start the release automation workflow on GitHub Action.

Update TypeScript

We don't update it by dependabot automatically to avoid a breaking change high frequently (See the PR that disable dependabot for TypeScript).

But this does not block to update TypeScript forever. We should update it if we have a new feature in newer TypeScript version! And then, let's release its change as breaking change as major version.