Skip to main content

GitHub Integration

The Closot–GitHub integration brings your development workflow and your project management together. Sync repositories, pull requests, and issues directly into Closot databases, embed live code previews inside pages, and automatically update task statuses as pull requests progress through review and merge.


Set Up the GitHub Integration

note

Only a user who is both a Closot workspace owner and a GitHub organization admin can set up the integration. Each Closot workspace can connect to only one GitHub organization.

  1. Go to SettingsConnectionsGitHub (Workspace)
  2. Click Connect
  3. Follow the GitHub authorization flow

GitHub Code Previews

Embed a live preview of any GitHub file, code snippet, or specific lines directly inside a Closot page — great for referencing implementation details, linking to relevant modules, or keeping engineering context close to your planning documents.

How to add a code preview:

  1. In GitHub, navigate to the file or lines you want to reference
  2. Copy the permalink (use the commit-specific URL, not the branch URL, for a stable reference)
  3. Paste the permalink into a Closot page
  4. Select Paste as preview

The preview displays the file content and reflects the specific commit or branch you linked.


Synced Databases

Sync GitHub repositories, pull requests, or issues directly into a Closot database — each GitHub item becomes a database row, automatically populated with its properties.

What syncs automatically:

GitHub PropertySynced to Closot
Title
Assignees
Description
State (open/closed/merged)
PR or Issue number
Creator
Created time
Merged, updated, and closed time
Reviewers
Labels and tags✗ (not supported)

The sync creates a table view by default. You can add filters, sorts, and additional views on top of this synced data just like any other Closot database.


GitHub Pull Request Property

The GitHub PR property lets you link a pull request directly to a Closot task. Once linked, the task's status updates automatically as the PR moves through the development pipeline.

Inside a GitHub pull request title or description, include one of the supported magic word phrases followed by the Closot task's Unique ID (e.g., PROJ-42).

Magic word categories:

CategoryKeywords
Closing (marks task as Done when PR merges)close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved, complete, completes, completed, completing
Reference only (links without auto-completing)ref, references, part of, related to, contributes to, towards

Example:

fixes PROJ-42

This links the PR to the Closot task with ID PROJ-42. When the PR is merged, the task's status is automatically set to Done.

Use a reference-only magic word (e.g., related to PROJ-42) if you want to link the PR for traceability without triggering the automatic status update on merge.

Auto-Update Task Status

You can configure which status value to apply for each stage of the PR lifecycle:

  1. Select the status property you want to auto-update from the dropdown in the GitHub PR property settings
  2. Set a target status for each state:
    • Opened
    • Review Requested
    • Approved
    • Merged

As the PR moves through these stages, the linked Closot task's status updates automatically.


Identity Mapping

Closot maps GitHub users to Closot workspace members when the email addresses match. To enable identity mapping in synced databases:

  • Make sure your GitHub email is not set to private (check GitHub → Settings → Emails)
  • Add your Closot account email to your GitHub profile

Once emails match, Closot can display the correct Closot user in assignee and creator fields instead of a plain GitHub username.


Disconnect GitHub

To disconnect the GitHub integration from your workspace:

  1. Go to SettingsConnections
  2. Click ••• next to GitHub
  3. Select Disconnect all users

This disables the integration for all workspace members. The integration can be reinstalled at any time using the same setup process.