Requirements
- You must be an Admin or Owner of the Arca workspace to connect and configure the integration.
- You need permission to install GitHub Apps on the target GitHub organization or personal account.
Connect GitHub
Open Integrations settings
In Arca, click your workspace name in the top-left, then go to Settings → Integrations.
Install the GitHub App
Click Connect. You are redirected to GitHub where you install the Arca GitHub App. Choose the organization or account, then select which repositories to grant access to (you can grant access to all repositories or only specific ones).
Return to Arca
After installation, GitHub redirects you back to Arca. The connection is now active and the integration page shows a connected status.
Select a repository and list
In the integration settings, choose the Repository you want to link with the current Arca workspace and the Arca list where synced issues should land. These selections are required before any sync features work.
Enable features and save
Turn on Issues sync and Magic words as needed, then click Save configuration.
Issues sync
Issues sync imports GitHub issues into Arca as tasks and keeps them updated as things change on GitHub.Enable issues sync
In the integration settings, turn on Issues sync and select a Sync mode (see below), then save.Sync modes
- From GitHub (one-way)
- Two-way
GitHub is treated as the source of truth. This mode does the following:
- Open GitHub issues are imported into the linked Arca list as tasks.
- When a GitHub issue is closed, its linked Arca task status is automatically moved to the first
completedstatus in your workspace. - Changes made to Arca tasks are not reflected back in GitHub.
Initial sync
An initial sync runs automatically (in the background, without blocking your workflow) whenever:- Issues sync is turned on for the first time.
- Issues sync is already on and you change the repository.
- Issues sync is already on and you change the target list.
Issues that already have a mapping in Arca are always skipped to prevent duplicates.
What gets imported
When a GitHub issue is imported, Arca creates a task with the following field mapping:| Arca task field | Value |
|---|---|
| Title | GitHub issue title |
| Description | GitHub issue body (plain text and Markdown preserved) |
| Status | First pending status in your workspace |
| Priority | None |
| Reporter | The workspace owner |
| List | The configured Arca list |
Arca does not modify or close issues on GitHub when you change a task’s status in Arca. Changes flow from GitHub to Arca, not the other way around for status updates, except when two-way mode exports initial tasks.
When a GitHub issue is closed
When a GitHub issue is closed, the linked Arca task status is updated to the firstcompleted status in your workspace. The task’s timeline and subscribers are updated in real time, no page refresh needed.
When a GitHub issue is reopened
When a GitHub issue is reopened, the linked Arca task status is automatically moved back to the firstpending status in your workspace, the same status assigned when the task was originally imported. This happens in real time via webhooks and requires no manual action.
The reopen only takes effect if the task is currently in a completed status category. If the task was already moved to an in_progress status category before the reopen event arrived, its status is left unchanged.
When a GitHub issue title changes
In two-way mode, renaming a GitHub issue title updates the linked Arca task title automatically. This works in real time via GitHub webhooks.When a GitHub issue description changes
In two-way mode, editing the body of a GitHub issue also updates the linked Arca task description automatically. GitHub issue bodies are written in Markdown; Arca converts them to rich text so they display correctly in the task editor.When an Arca task description changes
In two-way mode, editing the description of a linked task in Arca pushes the updated content to the corresponding GitHub issue body. The description is converted from Arca’s rich text format to Markdown before being sent to GitHub so that formatting (headings, lists, code blocks, task checklists, bold, italic, and links) is preserved correctly.Description sync only works in two-way mode. In one-way (From GitHub) mode, descriptions flow from GitHub into Arca during import but subsequent edits on either side are not synced.
Magic words
Magic words let developers reference and update Arca tasks directly from commit messages. When a commit is pushed to the linked repository, Arca scans the message for recognized keywords followed by a task identifier and performs the corresponding action.Enable magic words
In the integration settings, turn on Magic words and save.Task identifier format
Every Arca task has an identifier in the formatWORKSPACE-NUMBER, for example MYAPP-42. The workspace part is the slug of your workspace, and the number is the task’s sequential number. You can copy the identifier from the task context menu (Copy Full ID button). Identifiers are case-insensitive in commit messages.
Closing keywords
The following keywords, when followed by a task identifier, mark the task as completed by moving it to the firstcompleted status in your workspace:
- Moves the task to the first
completedstatus in your workspace. - Sends an in-app notification to all task subscribers (status changed).
- Updates the task in real time for everyone currently viewing it.
Part of keyword
The Part of keyword followed by a task identifier logs a relationship between the commit and the task. Example:
Magic words work on any commit pushed to the linked repository, regardless of the branch. Make sure your commit messages follow the
KEYWORD IDENTIFIER pattern exactly.Extra text before or after the pattern is allowed.Branch name generation
Any workspace member can copy the suggested Git branch name for a task. Open a task and look for the Copy branch name option. The format is controlled by the Branch naming style setting in the integration configuration:| Style | Format | Example |
|---|---|---|
| Title and identifier (default) | {title-slug}-{workspace}-{number} | fix-login-bug-myapp-42 |
| Identifier and title | {workspace}-{number}-{title-slug} | myapp-42-fix-login-bug |
| Identifier only | {workspace}-{number} | myapp-42 |
-; limited to 60 characters). You can change the style at any time in the integration settings without affecting existing branches.
Disconnect GitHub
To remove the GitHub integration from your workspace:- Go to Settings → Integrations → GitHub.
- Click Disconnect.
- Confirm the action.
Troubleshooting
GitHub issues are not being imported into Arca
GitHub issues are not being imported into Arca
Check the following:
- Issues sync is enabled and the configuration has been saved.
- A repository and a target list are both selected.
- The GitHub App has access to the repository. Go to GitHub → Settings → Applications → Arca and confirm the repository is listed under repository access.
Magic words in commit messages are not updating tasks
Magic words in commit messages are not updating tasks
Make sure:
- Magic words is enabled in the integration settings and saved.
- The commit message uses one of the recognized keywords (
fix,close,resolve, and their variants). - The task identifier format is correct:
WORKSPACE-NUMBERwhereWORKSPACEis your workspace slug. Check the slug in Settings → Workspace. - The repository being pushed to is the one selected in the integration settings.
A task was already completed and magic words are not firing again
A task was already completed and magic words are not firing again
If the task was completed via a closing commit or by closing the linked GitHub issue, reopening the GitHub issue will automatically move the Arca task back to
pending, which allows the next closing commit to fire correctly, no manual action needed.If the task was completed without a linked GitHub issue (for example by manual status change in Arca), reopen it by reopening the corresponding GitHub issue or by changing its status manually in Arca.Two-way sync is on but my Arca tasks are not appearing as GitHub issues
Two-way sync is on but my Arca tasks are not appearing as GitHub issues
The initial export runs in the background after you save the configuration. Wait a moment and then refresh GitHub. If issues still do not appear, check that the repository has Issues enabled (GitHub repository settings) and that the Arca GitHub App has write permission to the repository.
I changed the repository in settings but the old issues are still syncing
I changed the repository in settings but the old issues are still syncing
Changing the repository triggers a new initial sync against the new repository. Tasks already imported from the old repository remain in Arca but they are no longer linked to any active GitHub issue. Future webhook events from the old repository are ignored because the integration now points to the new repository.