Conversation
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
Completed Working on "Code Review"✅ Workflow completed successfully. |
There was a problem hiding this comment.
Findings: 2 MINOR (documentation mismatches).
Key themes:
- AGENTS.md overstates instrumentation test coverage—the console logger instrumentation lacks the documented co-located spec file.
- Quality standards mention strict TypeScript builds even though the tsconfig files are not configured for strict mode.
Next steps:
- Either add the missing console logger spec or adjust the documentation to describe the existing coverage accurately.
- Align the strict-build guidance with the actual tsconfig settings—enable strict mode or update the documentation to match current compiler flags.
| | --- | --- | --- | | ||
| | `src/` | Library source. `index.ts` re-exports the module, instrumentation providers, decorators, and SDK helpers. | TypeScript only; compilation output lives in `dist/` (generated via `nest build`). | | ||
| | `src/trace/decorators/` | Decorators such as [`span.ts`](src/trace/decorators/span.ts) and `traceable.ts`. | Decorators rely on metadata constants defined in `src/constants.ts`. | | ||
| | `src/trace/instrumentation/` | Instrumentation classes (e.g., [`controller.instrumentation.ts`](src/trace/instrumentation/controller.instrumentation.ts)) plus shared base classes and interfaces. | Every instrumentation has a co-located `.spec.ts` (Jest). | |
There was a problem hiding this comment.
[IMPORTANCE: minor] The Repository Structure table says every instrumentation has a co-located .spec.ts, but src/trace/instrumentation/console-logger.instrumentation.ts has no matching spec file in that directory, so the guidance is inaccurate. Please either add console-logger.instrumentation.spec.ts to match the implementation or update AGENTS.md to reflect the actual test coverage.
| | --- | --- | | ||
| | **Linting** | `npm run lint` must pass (ESLint + `@typescript-eslint`, Prettier integration). | | ||
| | **Testing** | `npm run test` / `npm run test:cov` using Jest. Global coverage thresholds: **80% branches**, **90% lines** (`jest.config.js`). | | ||
| | **Build** | `npm run build` executes `nest build` after cleaning `dist/` via `rimraf`. Build must succeed with strict TypeScript settings from `tsconfig*.json`. | |
There was a problem hiding this comment.
[IMPORTANCE: minor] The quality standards table states that npm run build must succeed with "strict TypeScript settings from tsconfig*.json", but tsconfig.json / tsconfig.build.json do not enable strict or related flags. This misleads contributors about the current tooling. Please either enable strict mode in the tsconfig files or revise AGENTS.md to describe the actual (non-strict) compiler settings.
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
|
Status update: release notes section has been applied to the PR description and verified. |
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
Completed Working on "Release PR Description"✅ Workflow completed successfully. |
🔄 Overcut automatically updated AGENTS.md with latest repository analysis.
Release Summary
This documentation-only release refreshes the AGENTS guide so contributors—human or automated—have an authoritative playbook for working within
@amplication/opentelemetry-nestjs. The expanded guide outlines the repository’s purpose, structure, coding standards, instrumentation patterns, and CI expectations to ensure consistent, safe contributions.Highlights
Features
Improvements