Skip to content

feat: add CI format check, flaky test handling, and enhanced onboarding docs#8

Closed
abhishyantkhare wants to merge 1 commit intomainfrom
cofounder/cto-onboarding-docs-cicd-v2
Closed

feat: add CI format check, flaky test handling, and enhanced onboarding docs#8
abhishyantkhare wants to merge 1 commit intomainfrom
cofounder/cto-onboarding-docs-cicd-v2

Conversation

@abhishyantkhare
Copy link
Copy Markdown

Summary

This PR adds targeted CI/CD improvements and significantly enhanced onboarding documentation for the Twenty monorepo.

Original Task

Please analyze my connected GitHub repository and set up comprehensive CI/CD and documentation. Detect the project type, add missing CI checks (ESLint, tests, linting), and generate CLAUDE.md and AGENTS.md files with coding standards and guidelines.

Health Analysis Results (Score: 16/18 — 89%)

Category Score Details
Style & Validation 5/6 ESLint v9, Prettier, Husky — added CI format check
Build System 3/3 Nx workspace, Yarn 4, multi-layer caching
Testing 3/4 1,221 test files — added flaky test retry handling
Documentation 2/3 README + PR template — significantly enhanced CLAUDE.md + AGENTS.md
Security 4/5 CodeQL, Dependabot, Dependency Review
CI Workflows 4/4 24+ active workflows + new format check

Changes

New: `.github/workflows/ci-format.yaml`

  • Prettier format check for all PRs and merge groups
  • Uses existing `changed-files.yaml` reusable workflow for skip detection
  • Uses existing `nx-affected` custom action for targeted checking
  • Runs `fmt` target on both `scope:frontend` and `scope:backend` packages
  • Follows the same status-check pattern as `ci-shared.yaml`

Enhanced: `CLAUDE.md`

  • CI/CD Pipeline Overview table (14 CI + 2 CD + reusable workflows)
  • Pre-commit Hooks documentation (Husky v9 + lint-staged)
  • Pre-PR Checklist: lint → typecheck → format → test
  • Custom ESLint Rules documentation (all 16 custom rules)
  • Testing Guide (unit, integration, E2E, Storybook)
  • Deployment Architecture (Render services, Docker, preview environments)

Enhanced: `AGENTS.md`

  • CI/CD Automated Checks Table
  • Custom ESLint Rules Summary (8 most impactful rules)
  • Code Review Checklist (quality, security, testing, CI compliance, database/API)
  • Preview Environment documentation
  • Coding Standards (TypeScript best practices, Nx module boundaries, naming conventions)

New: Flaky Test Handling

  • `packages/twenty-front/setupTests.ts`: Added `jest.retryTimes(2)`
  • `packages/twenty-server/setupTests.ts`: Added `jest.retryTimes(2)`

Type of Change

  • New CI workflow (format check)
  • Test infrastructure improvement (flaky test retry)
  • Documentation enhancement
  • No breaking changes

…ng docs

- Add CI format workflow (ci-format.yaml) to check Prettier formatting
  for frontend and backend packages on PRs and merge queue
- Add jest.retryTimes(2) to frontend and server test setups to handle
  flaky tests and improve CI stability
- Enhance CLAUDE.md with:
  - CI/CD Pipeline Overview with all 24+ workflows documented
  - Pre-commit Hooks section for Husky v9 + lint-staged setup
  - Pre-PR Checklist with commands developers should run
  - Custom ESLint Rules documentation (16 rules)
  - Testing Guide for unit, integration, E2E, and Storybook tests
  - Deployment Architecture for Render and Docker
- Enhance AGENTS.md with:
  - CI/CD automated checks table
  - Custom ESLint Rules summary (8 most impactful rules)
  - Code Review Checklist covering quality, security, testing, CI
  - Preview Environment documentation
  - Coding Standards for TypeScript, imports, naming conventions
@abhishyantkhare abhishyantkhare temporarily deployed to cofounder/cto-onboarding-docs-cicd-v2 - twenty-worker PR #8 February 9, 2026 22:32 — with Render Destroyed
@abhishyantkhare abhishyantkhare temporarily deployed to cofounder/cto-onboarding-docs-cicd-v2 - twenty-server PR #8 February 9, 2026 22:32 — with Render Destroyed
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 9, 2026

Welcome!

Hello there, congrats on your first PR! We're excited to have you contributing to this project.
By submitting your Pull Request, you acknowledge that you agree with the terms of our Contributor License Agreement.

Generated by 🚫 dangerJS against da3022e

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 9, 2026

🚀 Preview Environment Ready!

Your preview environment is available at: http://bore.pub:53821

This environment will automatically shut down when the PR is closed or after 5 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant