Conversation
|
There was a problem hiding this comment.
Pull request overview
This PR performs a Changesets-driven release/versioning step for @ciscode/health-kit, moving it from the placeholder version to the initial published version and materializing the generated changelog.
Changes:
- Bump
@ciscode/health-kitversion from0.0.0to0.1.0. - Add
CHANGELOG.mdentry for0.1.0(initial release notes). - Remove consumed Changesets files after running
changeset version.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| package.json | Updates the package version to 0.1.0 for the release. |
| CHANGELOG.md | Adds the generated changelog for the 0.1.0 initial release. |
| .changeset/thick-maps-raise.md | Removes an old/consumed changeset entry. |
| .changeset/health-kit-v0-1-0.md | Removes the consumed changeset used to generate 0.1.0 changelog/version bump. |
| - `GET /{path}/live` and `GET /{path}/ready` endpoints — 200 OK / 503 with `{ status, results[] }` body | ||
| - All indicators run concurrently via `Promise.allSettled` | ||
| - `path` option defaults to `"health"` |
There was a problem hiding this comment.
The changelog renders the default value with escaped quotes (\"health\"). In Markdown this will display the backslashes; update it to use normal quotes (e.g., "health" without escaping) so the rendered CHANGELOG matches the intended text.
| ### Features | ||
| - `HealthKitModule.register()` and `registerAsync()` — dynamic NestJS module with configurable liveness and readiness probes | ||
| - Built-in `PostgresHealthIndicator` (`SELECT 1`), `RedisHealthIndicator` (`PING`), `HttpHealthIndicator` (GET 2xx check) — all with configurable timeout | ||
| - `createIndicator(name, fn)` — inline factory for simple custom indicators | ||
| - `BaseHealthIndicator` abstract class + `@HealthIndicator('liveness' | 'readiness')` decorator for DI-based custom indicators | ||
| - `GET /{path}/live` and `GET /{path}/ready` endpoints — 200 OK / 503 with `{ status, results[] }` body | ||
| - All indicators run concurrently via `Promise.allSettled` | ||
| - `path` option defaults to `"health"` |
There was a problem hiding this comment.
### Features and the following bullets are indented relative to the rest of the file. Depending on the Markdown renderer this can be interpreted as part of the preceding list item or as a nested block, which makes the CHANGELOG harder to read. Consider making ### Features a normal top-level heading (no leading spaces) and aligning the feature bullets accordingly.
| ### Features | |
| - `HealthKitModule.register()` and `registerAsync()` — dynamic NestJS module with configurable liveness and readiness probes | |
| - Built-in `PostgresHealthIndicator` (`SELECT 1`), `RedisHealthIndicator` (`PING`), `HttpHealthIndicator` (GET 2xx check) — all with configurable timeout | |
| - `createIndicator(name, fn)` — inline factory for simple custom indicators | |
| - `BaseHealthIndicator` abstract class + `@HealthIndicator('liveness' | 'readiness')` decorator for DI-based custom indicators | |
| - `GET /{path}/live` and `GET /{path}/ready` endpoints — 200 OK / 503 with `{ status, results[] }` body | |
| - All indicators run concurrently via `Promise.allSettled` | |
| - `path` option defaults to `"health"` | |
| ### Features | |
| - `HealthKitModule.register()` and `registerAsync()` — dynamic NestJS module with configurable liveness and readiness probes | |
| - Built-in `PostgresHealthIndicator` (`SELECT 1`), `RedisHealthIndicator` (`PING`), `HttpHealthIndicator` (GET 2xx check) — all with configurable timeout | |
| - `createIndicator(name, fn)` — inline factory for simple custom indicators | |
| - `BaseHealthIndicator` abstract class + `@HealthIndicator('liveness' | 'readiness')` decorator for DI-based custom indicators | |
| - `GET /{path}/live` and `GET /{path}/ready` endpoints — 200 OK / 503 with `{ status, results[] }` body | |
| - All indicators run concurrently via `Promise.allSettled` | |
| - `path` option defaults to `"health"` |
* initiated dev environment * ops (ci): standardize publish validation and dependabot across all packages - Replace git tag --list strategy with package.json-driven tag validation in all 16 publish workflows; use git rev-parse to verify the exact tag exists rather than guessing the latest repo-wide tag - Update error guidance to reflect feat/** → develop → master flow - Standardize dependabot to npm-only, grouped, monthly cadence across all 16 packages; remove github-actions ecosystem updates - Add missing dependabot.yml to AuthKit-UI, ChartKit-UI, HealthKit, HooksKit, paymentkit, StorageKit * security: added CODEOWNER file for branches security \\ * ops: updated relese check workflow# * I health indicator interface and built in indicators (#1) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Health module and health endpoints (#2) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * chore(config): set module to CommonJS and moduleResolution to Node for dist output * chore(package): rename to @ciscode/health-kit * chore(deps): update package-lock * feat(indicators): add MongoHealthIndicator with ping command and timeout * test(indicators): add MongoHealthIndicator unit tests (success/error/timeout) * feat(services): add HealthService with Promise.allSettled orchestration * test(services): add HealthService unit tests (liveness/readiness/concurrency) * feat(controllers): add HealthController factory (GET live/ready, platform-agnostic) * test(controllers): add HealthController unit tests (200 ok / 503 ServiceUnavailableException) * feat(module): add HealthKitModule.register() dynamic module * feat(exports): update public API exports for health-kit --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Ihealth indicator interface and built in indicators (#3) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Health module and health endpoints (#5) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * chore(config): set module to CommonJS and moduleResolution to Node for dist output * chore(package): rename to @ciscode/health-kit * chore(deps): update package-lock * feat(indicators): add MongoHealthIndicator with ping command and timeout * test(indicators): add MongoHealthIndicator unit tests (success/error/timeout) * feat(services): add HealthService with Promise.allSettled orchestration * test(services): add HealthService unit tests (liveness/readiness/concurrency) * feat(controllers): add HealthController factory (GET live/ready, platform-agnostic) * test(controllers): add HealthController unit tests (200 ok / 503 ServiceUnavailableException) * feat(module): add HealthKitModule.register() dynamic module * feat(exports): update public API exports for health-kit --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Custom indicator api and health service (#7) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * chore(config): set module to CommonJS and moduleResolution to Node for dist output * chore(package): rename to @ciscode/health-kit * chore(deps): update package-lock * feat(indicators): add MongoHealthIndicator with ping command and timeout * test(indicators): add MongoHealthIndicator unit tests (success/error/timeout) * feat(services): add HealthService with Promise.allSettled orchestration * test(services): add HealthService unit tests (liveness/readiness/concurrency) * feat(controllers): add HealthController factory (GET live/ready, platform-agnostic) * test(controllers): add HealthController unit tests (200 ok / 503 ServiceUnavailableException) * feat(module): add HealthKitModule.register() dynamic module * feat(exports): update public API exports for health-kit * feat(indicators): add createIndicator inline factory with timeout support * test(indicators): add createIndicator unit tests (true/false/void/throw/timeout) * feat(indicators): add BaseHealthIndicator abstract class with result() helper * test(indicators): add BaseHealthIndicator unit tests * feat(decorators): add @healthindicator decorator for auto-registration by scope * test(decorators): add @healthindicator decorator unit tests * feat(module): extend HealthKitModule.register() with indicators[] option for DI-based auto-registration * feat(exports): export createIndicator, BaseHealthIndicator, @healthindicator, HealthIndicatorScope * chore(package): update description to mention MongoDB --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 80 ihealth indicator interface and built in indicators (#8) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 81 health module and health endpoints (#9) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * chore(config): set module to CommonJS and moduleResolution to Node for dist output * chore(package): rename to @ciscode/health-kit * chore(deps): update package-lock * feat(indicators): add MongoHealthIndicator with ping command and timeout * test(indicators): add MongoHealthIndicator unit tests (success/error/timeout) * feat(services): add HealthService with Promise.allSettled orchestration * test(services): add HealthService unit tests (liveness/readiness/concurrency) * feat(controllers): add HealthController factory (GET live/ready, platform-agnostic) * test(controllers): add HealthController unit tests (200 ok / 503 ServiceUnavailableException) * feat(module): add HealthKitModule.register() dynamic module * feat(exports): update public API exports for health-kit --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 82 custom indicator api and health service (#11) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * chore(config): set module to CommonJS and moduleResolution to Node for dist output * chore(package): rename to @ciscode/health-kit * chore(deps): update package-lock * feat(indicators): add MongoHealthIndicator with ping command and timeout * test(indicators): add MongoHealthIndicator unit tests (success/error/timeout) * feat(services): add HealthService with Promise.allSettled orchestration * test(services): add HealthService unit tests (liveness/readiness/concurrency) * feat(controllers): add HealthController factory (GET live/ready, platform-agnostic) * test(controllers): add HealthController unit tests (200 ok / 503 ServiceUnavailableException) * feat(module): add HealthKitModule.register() dynamic module * feat(exports): update public API exports for health-kit * feat(indicators): add createIndicator inline factory with timeout support * test(indicators): add createIndicator unit tests (true/false/void/throw/timeout) * feat(indicators): add BaseHealthIndicator abstract class with result() helper * test(indicators): add BaseHealthIndicator unit tests * feat(decorators): add @healthindicator decorator for auto-registration by scope * test(decorators): add @healthindicator decorator unit tests * feat(module): extend HealthKitModule.register() with indicators[] option for DI-based auto-registration * feat(exports): export createIndicator, BaseHealthIndicator, @healthindicator, HealthIndicatorScope * chore(package): update description to mention MongoDB --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 80 ihealth indicator interface and built in indicators (#12) * chore(config): add @interfaces/* and @indicators/* path aliases * chore(config): rename eslint.config.js to .mjs to fix ESM loading * chore(git): fix husky pre-commit hook for v10 compatibility * feat(interfaces): add IHealthIndicator, HealthStatus, HealthIndicatorResult * feat(indicators): add PostgresHealthIndicator (SELECT 1 + timeout) * test(indicators): add PostgresHealthIndicator unit tests (success/error/timeout) * feat(indicators): add RedisHealthIndicator (PING + timeout) * test(indicators): add RedisHealthIndicator unit tests (success/error/timeout) * feat(indicators): add HttpHealthIndicator (GET + 2xx check + timeout) * test(indicators): add HttpHealthIndicator unit tests (2xx/non-2xx/network/timeout) * chore(deps): update package-lock after npm install * fix(interfaces): add optional details field to HealthIndicatorResult --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 81 health module and health endpoints (#18) * fix(services): rename indicators to results in HealthCheckResult response * fix(tests): update health.service.spec to use results instead of indicators --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 82 custom indicator api and health service (#23) * fix(services): rename indicators to results in HealthCheckResult response * fix(tests): update health.service.spec to use results instead of indicators * chore(indicators): remove MongoHealthIndicator * feat(module): make path optional with default 'health', add registerAsync * feat(exports): remove MongoHealthIndicator, export HealthModuleAsyncOptions * chore(package): add @nestjs/terminus peer dep, fix description * chore(indicators): remove MongoHealthIndicator spec * refactor(module): extract shared logic to eliminate code duplication --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 83 testing suite (#25) * chore(indicators): remove MongoHealthIndicator spec * test(module): add HealthKitModule spec - register, registerAsync, path default --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 84 readme changeset publish v0.1.0 (#26) * fix(package): remove unused bundled dependencies (class-transformer, class-validator) * chore(package): bump version to 0.1.0 --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * docs(readme): rewrite README and add changeset for v0.1.0 (#28) - Rewrite README.md for @ciscode/health-kit (remove template content) - Add register/registerAsync usage examples - Document built-in indicators: PostgresHealthIndicator, RedisHealthIndicator, HttpHealthIndicator - Document custom indicator APIs: createIndicator, BaseHealthIndicator + @healthindicator - Add 200/503 response body examples - Add API reference tables - Add .changeset/health-kit-v0-1-0.md: minor bump (0.0.0 -> 0.1.0) - Fix .changeset/config.json repo field to CISCODE-MA/HealthKit - Set package.json version to 0.0.0 (changeset will bump to 0.1.0) Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * Feat/compt 84 readme changeset publish v0.1.0 (#30) * docs(readme): rewrite README and add changeset for v0.1.0 - Rewrite README.md for @ciscode/health-kit (remove template content) - Add register/registerAsync usage examples - Document built-in indicators: PostgresHealthIndicator, RedisHealthIndicator, HttpHealthIndicator - Document custom indicator APIs: createIndicator, BaseHealthIndicator + @healthindicator - Add 200/503 response body examples - Add API reference tables - Add .changeset/health-kit-v0-1-0.md: minor bump (0.0.0 -> 0.1.0) - Fix .changeset/config.json repo field to CISCODE-MA/HealthKit - Set package.json version to 0.0.0 (changeset will bump to 0.1.0) * chore(package): set version to 0.1.0 --------- Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * chore(release): version packages (#31) Co-authored-by: saad moumou <saad.moumou.coder@gmail.com> * ci: update release check workflow * ops: updated release check jobs --------- Co-authored-by: Zaiidmo <zaiidmoumnii@gmail.com> Co-authored-by: saad moumou <saad.moumou.coder@gmail.com>



Summary
Why
Checklist
npm run lintpassesnpm run typecheckpassesnpm testpassesnpm run buildpassesnpx changeset) if this affects consumersNotes