calcom / synclinear.com

End-to-end sync of Linear and GitHub.

Initially created by Haris Mehrzad and Spacedrive, now extended and maintained by Ted Spare and Cal.com.

SyncLinear.com

This is a system to synchronize Linear tickets and GitHub issues when a specific label is added.

This allows contributors to work with open source projects without having to give them access to your internal Linear team.

👋 Visit SyncLinear.com to try it!

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

To get started, see the contributor docs!

Self-hosting

If you prefer to host your own database and webhook consumer, we offer one-click deployment on Railway and DigitalOcean:

Note To deploy to Railway, delete the Dockerfile in your fork. Working on a permanent solution.

For finer-grained control, please see the self-hosting instructions.

If you need any help, please check for related issues or open a new one.

Troubleshooting

Some common error scenarios and how to work through them can be found here in the troubleshooting guide.

synclinear.com's Issues

HTTP 403 for a github webhook

I followed the instructions to configure the sync, but on github side I see that the webhook returns a 403 status. Is there an API key that I have to set up?

As a result, GitHub -> Linear sync doesn't work

Here's a Github webhook response body for the 403 request:

{"success":false,"message":"GitHub webhook secret doesn't match up."}

To reproduce:

• follow the steps on https://synclinear.com/ to link github and linear
• remove a newly created webhook manually from github repo
• delete synchronisation from https://synclinear.com/
• re-create sync on https://synclinear.com/

Unable to connect: "Failed to save sync"

Hi, I am trying to set up synclinear and I am not able to get pass the webhook deployment step. I keep getting "Failed to save sync" error, even though I can see that the webhooks have been deployed correctly to both apps.

I tried deleting it and reinstalling, but no dice. I suspect that when I first set it up, I let the initial authorisation timed out by accident, resulting in some orphaned data in the DB that didn't get cleared out when I uninstalled the apps from Linear/GitHub's end. How can I go about doing a full reset? Thanks!

Runway deployment broken?

I deployed the app to runway but Linear is telling me the URL for hooking it up is invalid.

Here is an API key sanitized version

https://linear.app/oauth/authorize?client_id=1234&redirect_uri=https://app-production-111.up.railway.app&scope=write&state=linear-asdf&response_type=code&prompt=consent

I played around with the uri.. adding /? between the domain and the url params. As well as doing encodeURIComponent on the url, but I got the same thing from Linear.

This could be a Linear bug! Unsure.

Anyone else seeing this?

Sync private repository

Hi!
I've tested synclinear tool with public repository, it works so good!
But it's possible to sync private repository?

Thank you so much!

why write permissions?

from a potential user:

why does it need the permission to write code to public/private repositories?

Adding a comment with image in Github doesn't show the image in Linear

Adding a new comment in Github with an image doesn't show the image in Linear
The image's markup is there but it's not parsed it seems

Wrong team member shown on GH for anon Linear events

This is a bug report and also a feature request.

Some things I've noticed while testing with my team is that

• When a member of my team self-assigned themselves to a Linear issue, it showed that I assigned them on GitHub, which is untrue.
• When a member of my team closed a Linear issue, it showed that I close the issue on GitHub, which is untrue.
• I've noticed that the <username> on Linear footer text is omitted presumably by design, my feature request is that this isn't the case, as it does help to see the source of comments. [See image below]

Thanks again!

`Failed to save sync` after Linear team fails to save

We were wanting to try out your product but running into an error Failed to save sync. when attempting to link the Github webhook to our Linear webhook. When looking at the deployed webhook on the Github side, it says Last delivery not successful. Invalid HTTP response: 404 error.

Any advice?

sync projects

Gitlab support

Hi,

I was wondering if you'd be interested in supporting Gitlab repositories too.
This is something that we are exploring at Front-Commerce and with maybe some guidance about the caveats to be careful at, we could even contribute this feature.

Before this, I wanted to start a discussion here to see if you would be interested in including this in the project or if we'd rather fork it for internal purposes.

Thanks!

GitHub webhook secret doesn't match

Hey! So the sync from Linear --> GitHub is working flawlessly, however from GitHub --> Linear, its saying that the websocket secret doesn't match up. So then I unsycned all my teams and redid the setup and unfortunately the problem persisted.

Thanks in advanced for any help! 💗

repo: mmattDonk/AI-TTS-Donations

milestone not created after assigning an issue a new cycle in linear

calcom/cal.com#6702

Roadmap

• #4
• #5
• #12
• #3
• #6
• #7
• #8

Issue moved back to 'in progress' after PR is created

When I manually update an issue in linear to 'in review', create a PR afterwards in Github, the issue status in linear goes back to 'in progress'.

Sync multiple teams/repos

Can we sync the whole organization instead of individual repos? That way we can use Linear as a "central command" for our mix of public and private repos.

label sync stopped working

move linear_public_id, linear_canceled_state_id, etc. from .env to a database

Deployment to Digital ocean fails

Getting this error when using the installation link in the readme.

Error while creating app from Git template
Could not create app from Git template.

Yaml: line 16: did not find expected '-' indicator.

a database table that maps linear user to github user

Feature suggestion: Syncing public github comments

Why?

It would be amazing to sync public github conversations to be visible inside Linear. Today the comments in linear are a bit weird because they only reflect core team conversations and missing community comments.

How?

Not sure exactly how best to implement but had in mind two ways:

• Using an existing users as a commenter in Linear and add an annotation in the comment that will link to the real commenter github page
• Somehow use the integration account (similar to the one opening the issues in Triage today)

sync does not work from linear team -> github

Hi,

somehow the sync only works in one direction for me at the moment (github -> linear).
When I make changes on github they appear in linear but not vice-versa. I.e. any change (such as a comment, marking an issue with Public etc.) on linear does not lead to a change on github.

See below the involved repos:

The linear webhook appears to be there as well:

be able to add label "linear" to github ticket to sync into linear

if a community member creates a ticket in github, it would be great to give it a "linear" label to sync it into linear

Label "linear" from GitHub does not sync the other labels

From github, I'm adding "linear" label:

source: udecode/plate#2025

Linear result:

map correct tagged @username for descriptions and comments

similar as #12 we need to map usernames to tag the right person in github (githubUsername) and linear (linearUsername)

linearUsername	githubUsername
`@alan`	`@alannnc`

Manually removed webhook breaks re-sync

I had the same problem.
Webhooks were added when first synchronizing. They will not be added when manually removed and then synchronized again.
Secret is missing on GitHub if I fill it in manually, so how do you get secret or can you automatically add it again when synchronizing after detecting the deleted webhooks?

Originally posted by @blockmia in #27 (comment)

Sync messes up mermaid diagrams

Here's an example:

calcom/cal.com#6809

When editing it turns this (I'm using ' on purpose to demo)

'''mermaid
block code
'''

into this

'''
block code
'''

Nothing is syncing, how do I debug?

I've set up syncing between a Linear project and a Github repo on https://synclinear.com/. It says it's successful but I'm not seeing any Github issues show up after i add the label "Public" to issues in Linear.

How do I go about debugging this?

Listening to multiple teams at once?

I use multiple teams for 1 project/repo for things like Frontend/Backend, I'd be nice if I could listen to all of the teams in my 1 Linear organization with only 1 linear-to-github API running.

GitHub webhook deployment not working.

Hey there team, thanks for this project, seems very cool!

An issue I've faced while trying to get setup is that the Deploy Webhook button seems to be already deployed when I go to deploy the GitHub webhook on my repo, but when I look in the Webhook settings of the GitHub repo there is no SyncLinear webhook, there is however a Discord one I use to relay events, it may be possible that it's conflicting with the setup?

I'm not sure if this is something I've broken accidentally, but I've followed the steps that were detailed so not really sure where I went astray, if it was me.

Thanks!

Edit and delete comments

How to reproduce ?

• try creating any comment on any issue
• Then edit the comment on linear.

the changes are not synched to github comments.

Problem with bulk adding "Public" label. Sync broken

The integration seemed to be working correctly, but there appears to be an issue after I tried to sync 38 tickets at a time. Only 5 made it, and now the other tickets in the team don't sync. Even after refreshing the team's active-sync. Any suggestions?

Stellar work on this project btw. Love the details in that integration setup ✋

From the GH webhook 404 response:
{"success":false,"message":"Could not find issue's corresponding team."}

sync milestones

sync:
https://github.com/calcom/cal.com/milestones

with

sync labels

Issues with syncing two repos to the same linear team

I have one linear team, and two github repos that I would like to sync the same linear issues between both repos. Currently, the issues are only syncing between one of the repos that I have integrated. Can anyone else replicate this?

Sync not working after convert `Public` to workspace label

Description

I converted Public from the team label to the workspace label in linear, then the sync service started not working on newly added issues.

Steps to Reproduce

1. setup sync service between linear team A and GitHub repository B
2. create a label named Public in team settings
3. convert Public to workspace label
4. label an issue in A with Public
5. the issue will not sync to B

To convert a label to a workspace label

sync breaks images

calcom/cal.com#5327 (comment)

Support Node 16.5+ for self-hosting

I tried running synclinear myself and noticed there are several code changes that seem to be deployed to synclinear.com but are not present in the main branch of this repo, such as:

changes to schema:

-- AlterTable
ALTER TABLE "github_repos" ADD COLUMN     "webhookSecret" TEXT NOT NULL;

-- AlterTable
ALTER TABLE "syncs" DROP COLUMN "githubWebhookSecret";

sync footer:
the sync footer that synclinear.com posts looks entirely different than the one in the source code..

node version:
seems like synclinear is breaking with any node version 16.5 or higher due to helperdiscord/petitio#41 so none of the one-click deployments (which use a higher node version) work by default.

Could you please check in the latest code into this repo? Thanks!

Issues created with "linear" label open 2 tickets

See Cal #5699

Opening a GitHub issue in a synced repo with the linear label triggers two sequential webhooks: issue and labelled.

sync assignee

probably requires a table to map

linearUsername

githubUsername

Support for new Linear threads?

Now that Linear support threads how should be handle them in GitHub?

My first guess would be to use quoted replies:

sync "priority" from linear to github labels

Allow syncing anonymous issues created from GitHub to Linear

Context

We use linear to triage all our GitHub community issues, and when issues are created by community members they are not synced to linear.

How?

I was thinking on adding a similar to the anonymous comment functionality, that guest users issues will be created as the "sync app" similar to how the comments work now.

Sync Linear Estimates?

Estimates are pretty cool but GitHub has no concept for it.

should it create labels? XS, M, L, etc.?

there are also different kinds of estimates:

`Error deploying web hook: Error: url not unique`

We keep getting this each time we go to sync one with specific team on Linear. Other teams work, but not this one specific one. The error message isn't giving me enough information to fix it. Anyone have any ideas?

does not add a webhook to github

It doesn't add a webhook to my github repository when I select my project repo to sync with linear.app, it loads, but when I go back to github I don't see a webhook added.

synclinear.com

GitHub settings

---

PS: The first one did add a webhook, but then I deleted it and re-synced my repo, but this time it no longer added a webhook.

removing and re-adding a sync breaks things

Hi, I added a sync between aptos-labs/test-repo (github) <> aptoslabs/test-team (linear), which initially seemed to kind of work.
Since I wanted to try out various config combinations and start from clean state, I removed the sync and synclinear webhooks (both on github and linear) afterwards.

Now when I re-add the sync, it seems like it's not recreating the webhooks on either end.

Can't use synclinear with some organization repositories

I have some organization repositories for which this tool will not work and some for which it will, and I can't for the life of me figure out why. I have tested it, and it is all the things I dreamed of and more, but I can't use it on the repository I want to most of all. The repository is part of a GitHub organization, of which I am the owner and a member. I can use sync linear on repositories of another organization, of which I am only a member of a team. I can't figure out what is different between the two.

To be clear, the repositories I can't add simply don't show up in the dropdown. I know I can add web hooks to these repositories through 3rd party apps because I do so for CircleCI.

I will continue to explore your code base, but any time you can give to this confusion is much appreciated!

Self hosted github auth problem

I tried the self hosted version of the app (on railway)

I'm getting the following error when trying to log in with my github account:

Here's the github OAuth app settings:

Assignee gets removed

See CAL-729

OAuth for every user so the ticket and comments are being created by the Author, not by the bot