Skip to main content
doc0blade47/compdocumentation home
Sign in

Release Process

Last updated Oct 11, 2026
Relevant source files

The following files were used as context for generating this wiki page:

The release process for the comp project encompasses automated package publishing, rigorous dependency management, and defined build and deployment strategies. This ensures consistency across internal packages, simplifies the integration of external dependencies, and provides a structured approach to delivering the application and its components.

This document outlines the mechanisms in place for managing releases, from internal package versioning to deployment considerations.

Automated Package Publishing

The project utilizes semantic-release to automate the publishing of internal packages to npm. This process is triggered upon merging pull requests into the release branch, ensuring that new versions are released consistently and follow semantic versioning principles based on conventional commits.

Published Packages

The following internal packages are automatically published:

Package NameDescription
@comp/dbDatabase utilities with Prisma client
@comp/emailEmail templates and components
@comp/kvKey-value store utilities using Upstash Redis
@comp/uiUI component library with Tailwind CSS

Sources: README.md:166-169

Publishing Workflow

The publishing workflow is designed to be fully automated once changes are merged into the release branch.

  1. Setup NPM Token

    To enable semantic-release to publish packages, an npm token must be configured as a GitHub repository secret named NPM_TOKEN.

  2. Trigger Release

    Create and merge pull requests into the release branch. semantic-release will automatically detect conventional commits and bump versions accordingly.

Sources: README.md:173-174

Local Development and Testing

Developers can build and test packages locally before they are published.

# Build all packages in the monorepo
bun run build
 
# Build a specific package, e.g., @comp/ui
bun run -F @comp/ui build
 
# Test the release process without actually publishing
bun run release:packages --dry-run

Sources: README.md:180-185

Dependency Management and Consistency

The project uses syncpack to enforce consistent dependency versions across all packages within the monorepo. This tool is configured via .syncpackrc.json to manage internal package references, ensure uniform versions for critical external dependencies, and prevent the inclusion of forbidden modules.

Configuration Overview

Sources: .syncpackrc.json

Key Consistency Rules

Internal Package Versioning

All internal @comp packages are configured to use exact workspace:* versions. This ensures that all parts of the monorepo reference the latest local version of internal dependencies.

semverGroups: This group specifically targets internal packages, ensuring they use workspace:* for their version ranges.

LabelPackagesDependenciesRange
Use exact versions for internal packages@comp/**@comp/**workspace:*

versionGroups: These groups ensure that critical external dependencies maintain consistent versions across all packages in the monorepo.

LabelDependencies
Ensure React is consistentreact, react-dom, @types/react, @types/react-dom, react-is
Ensure Next.js is consistentnext
Ensure TypeScript is consistenttypescript
Ensure common build tools are consistentpostcss, tailwindcss, @tailwindcss/**, autoprefixer
Ensure testing tools are consistent@types/node, prettier, turbo
Ensure ESLint is consistenteslint, eslint-config-next

lintRules: A set of rules to forbid certain dependencies, typically Node.js built-in modules or mistakenly added packages, to maintain a clean and predictable dependency graph.

RuleDependenciesMessage
forbiddenDependenciescrypto, buffer, fs, path, os, install, npmThis is a Node.js built-in module or a mistakenly added dependency

Sources: .syncpackrc.json

Deployment Considerations

While detailed deployment steps for Docker and Vercel are "coming soon", the project's package.json files provide insights into the planned deployment strategies and build processes.

Build and Deployment Scripts

The apps/api/package.json defines several scripts relevant to building and deploying the API service:

Script NameCommandDescription
prebuildbun run db:generateGenerates the Prisma client before the main build process.
buildnest buildCompiles the NestJS application.
build:dockerbunx prisma generate && nest buildPrepares the application for Docker by generating Prisma client and then building the NestJS app.
deploy:trigger-prodnpx trigger.dev@4.0.6 deployDeploys Trigger.dev jobs to the production environment.
start:prodnode dist/mainStarts the compiled NestJS application in production mode.

Sources: apps/api/package.json:96-100, apps/api/package.json:104

Was this page helpful?