Claron
    Documentation
    PROJECTSReviewed

    Projects & Builds

    A project represents one web application. It is linked to a Git repo and has its own annotations, builds, members, and integrations. Each project gets a hosted preview URL.

    Connect the repository

    1. Select the account or workspace that will own the project

      Open Settings → Version Control and connect GitHub, GitLab, or Bitbucket using the provider shown for your repository.

    2. Authorize the correct account and grant repository access

      For a private repository, ensure the provider connection includes that repository; being able to view it in your own browser is not enough.

    3. Open Projects → New Project, choose the connected provider, select the repository and branch, then review the detected settings.

    4. If access requires approval, submit the request

      Track it in your work/approval queue; an authorized owner or workspace manager must approve before the requested operation takes effect. Read a rejection reason and correct the request before resubmitting.

    Configure the application build

    Create the project, open its build logs, and verify that the preview loads a real application route. For new configuration or changed variables, make a new build; do not assume an old preview has picked up new settings.

    SettingWhat to enter
    Root directoryThe app directory relative to the repository root. Use the actual package location for a monorepo.
    Install commandThe package manager command matching the app's lockfile and workspace layout.
    Build commandThe app's production build command. Check the framework's required version and adapter.
    Static outputThe directory your command actually creates, such as dist. Do not use .next as a generic static folder.
    SSR configurationThe supported server/framework output and adapter selected for your app. A successful static build does not prove SSR runtime compatibility.
    Environment variablesThe build/runtime values required by the app; save them before the build. See Environment Variables.

    Choose review access

    Use the project's Team controls to invite a developer, tester, or client and choose the role deliberately. Workspace People manages workspace membership; it is not the same role list.

    Client and guest visibility is based on public annotations in their permitted project/review context, not an author-only rule. They may see other public reports. Internal annotations and staff-only comments are restricted. See Team & Roles before sharing confidential issue details.

    Project owners manage project configuration and backend setup. Workspace authority can affect effective access; project ownership is not simply a guarantee that whoever clicked Create can bypass all workspace rules.

    Repository or preview setup failed

    For a missing repository, confirm the selected provider account and granted repositories, then reconnect or refresh. For Cannot find module, check installation, dependency declarations, monorepo root, and build paths. For a missing-variable error, check the required variable name and where the framework reads it.

    Inspect the first actionable error in the failed build, not necessarily its first stderr line. Use Builds & Previews to retry after correcting the cause.

    CREATING A PROJECT

    Click Projects → New Project to open the 5-step wizard. In workspace mode, members and above can submit project creation requests when approval policy is enabled.

    Select Repository

    Git repository + branch

    Build Config

    Auto-detected

    3

    Environment Vars

    Encrypted at rest

    4

    Invite Team

    Assign roles

    5

    Done!

    Preview URL live

    1

    Select Repository

    Connect the Git provider for your repository, browse repos, and choose a branch to track (default: main). If it's a monorepo, select a specific app path.

    2

    Build Configuration

    Claron auto-detects your framework. Review and adjust install command, build command, and output directory.

    Next.jsViteNuxtAstroRemixCRASvelteGatsby
    3

    Environment Variables

    Add key/value variables your build needs. Values are encrypted at rest and hidden after save.

    4

    Invite Team

    Invite developers, testers, or clients as project members and assign their role. One-time reviewers can be invited through a collaborative session or a review round; neither invite adds them as project members.

    ✓

    Done!

    Claron queues the initial build. Once complete, your preview URL is live and ready for review.

    BUILD CONFIGURATION

    Branch
    Which branch is tracked and built
    Build Command
    npm run build
    Output Directory
    dist (static) · .next (Next.js SSR)
    Install Command
    npm install
    Pre-build Command
    Runs before the install step
    GitHub Webhook
    When configured, builds the tracked branch after a push through the connected GitHub App

    BUILD STATUSES

    Queued
    Waiting for a build slot to become available
    Building
    Clone, install, and build in progress
    Success
    Build completed — preview is live
    Failed
    Build failed — check the build logs
    Cancelled
    Manually cancelled before completion

    BUILD LOG VIEWER

    Go to Project → Builds → click any build. The log streams in real-time. Lines are colour-coded:

    bash
    [system] ◉ Cloning repo: github.com/user/claron-web (cyan)
    [stdout] > vite build (white)
    [stdout] ✓ Built in 14.2s
    [stderr] WARN missing peer: react-dom@^18.0.0 (amber)
    [system] ◉ Preview live at preview.claron.dev/prj_01HZ

    MONOREPO SUPPORT

    Claron auto-detects Turborepo, Nx, and pnpm workspaces. Select exactly which app to build from the app picker:

    BUILD FAQ

    MANAGING MEMBERS

    Go to Organization → People in the sidebar, switch to the Invites tab, and click the Invite button to add developers, testers, or clients as project members. One-time reviewers join through a collaborative-session or review-round invitation; those invitations do not add them as project members.

    Owner

    Project's owning account

    Full access: settings, integrations, and member management

    Developer

    Engineers working on the codebase

    View/manage annotations, apply fixes, access integrations, and vote on resolved/wont-fix approvals

    Tester

    QA specialists validating builds

    View/manage annotations, update status directly (including resolved/wont-fix), and access integrations

    Client

    Stakeholders / end clients

    Report and discuss permitted public annotations, including other reviewers' reports; no internal staff context or code-fix actions

    Guest

    One-time reviewers invited to a collaborative session or review round

    Limited annotation and comment access in the invited review context

    APPROVAL WORKFLOWS

    Depending on workspace policy, project and integration actions may enter a review queue before they are applied.

    Project creation
    Members and above can submit. Owners and admins approve when project-create approval is enabled.
    Integration connect
    Managers, admins, and owners can approve integration connection requests when integration approval is enabled.
    Annotation status change
    Tester role can move annotations to resolved or wont_fix directly. Developer requests require more than 50% of project developers to approve, unless manager/admin/owner approves directly.

    GUEST REVIEW LINKS

    One-time reviewers can join without project membership through an invitation to a collaborative session or a review round. These are separate invite flows; see Review Rounds for asynchronous, version-specific reviews.

    1Start a collaborative review session for your project
    2Open Invite collaborators in the session controls
    3Copy the generated link and share with your client
    4Guest opens the valid invite, enters their name and email, and joins the invited session