jtormey / linear-sync Goto Github PK

Heya! Awesome tool, really excited it might save us from having to use Jira! 🥳 We however have a requirement to not give linear-sync.com permission to our private issue data.

I originally tried to solve this by logging in with a dummy user which is outside our github org. to avoid giving the app access to our org's private issues. The user is r2c-demo, and I'd want to subscribe to issues on returntocorp/semgrep (and some other public repos). But sadly, it's not possible to select a repo unless the user is a member of the repo's organization:

I even tried to reverse engineer the API to subscribe to an undisplayed repo ID, but Phoenix's websockets are too difficult for me to wrangle like that. I wanted to try to find other ways around private permissions, but can't play around too much since #16 prevents me from switching github users.

Possible solutions

1. When I logged in, linear-sync used an OAuth app. Using a GitHub app instead would make it possible to give access only to select repos. See https://docs.github.com/en/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps. I'm quite confused about this point actually, because the README instructs users to create a github app, but I think I saw the oauth app prompt when I first tried to log in.
2. Two-way sync would not work, but at least for one-way, it should be possible to enter any public repository ID, right? The GitHub API allows reading public issue data whether you're in the org or not. Though I ran the app offline and noticed that webhook subscriptions need to be created on the repo, which cannot be automated without write access.
3. This is a possible solution for me personally, not for the project: we could self-host linear-sync to get rid of the strict permissions requirement.

Hi @jtormey. Amazing tool, thanks so much. I switched to this after https://github.com/calcom/synclinear.com proved unreliable.

Problem

Creating issues in Github results in perfectly functioning two-way syncing.

But creating issues in Linear seems to break syncing.

That is, after the Linear issue successfully syncs to Github:

• Subsequent Github comments / close statuses / title changes don't sync to Linear
• And the reverse, Linear comments / close statuses / title changes don't sync to Github

Bug context

Sync ID is 5bd2722d-eaa4-4dd5-9d7f-489aa6d6d771

When I check out the webhook in the Github repo, here's what I see:

I can't debug this any further from the error message itself.

First of all thanks for the great project. I can't set it up with a new repo of mine though. I can connect my GitHub account, create an API key, setup an issue sync but when pressing "enable" the following error pops up:

The repository I try to connect is the following.

Any idea what could cause the problem?

If one syncs two Github repos to the same team, which repo will a new Linear issue in that team sync back to? It would be helpful if we could (optionally) specify the Linear project that a connection syncs to/from:

• If a project is set, then Linear issues will only copy to Github if they are part of the team.
• Vice-versa, Github issues that sync to the team will be auto-attached to the defined project, if a project is set.

Previously, Linear Sync went one way - pulling issues from Github and adding them to Linear. It seems like two way sync is now the default. Is there a way to restore the previous behavior?

Currently, this application only supports syncing new issues from GitHub to Linear. However, it would be nice if sync worked the other way as well.

Example use cases:

• When an issue is completed or archived in Linear, close the corresponding GitHub issue
• When an issue is commented on in Linear, add the comment to GitHub as well (maybe requiring some special syntax in the message, so that some comments may remain private)

For anyone looking to implement this feature, here are the relevant sections of the codebase:

• The code for setting up and tearing webhooks can be found in Linear.IssueSyncService, and will simply need to be uncommented
• Creating webhooks is currently broken, due to changes in Linear's API. This will have to be fixed in Linear.LinearAPI (and is the reason for the previously mentioned commented code)
• Incoming webhook requests from Linear will have to be handled and the "business logic" implemented, which is done in Linear.Synchronize

Currently, Linear Sync imports the issue title and text, but does not sync Github labels with labels in Linear.

I noticed in #14, sync is added in the reverse direction (Linear -> Github). It would be amazing if this worked in the other direction as well!

Current Behavior: When creating a new Github issue that has labels, Linear Sync will import the issue title and text but will not include the labels.

When adding labels to an existing issue, the sync process works as expected and the labels from Github are added to Linear.

Expected Behavior: Linear Sync should import the labels for new issues, the same way that it syncs labels when they are added to existing issues.

See screenshot of what pressing the Sponsor button shows:

Hey,

How can I delete my account on the sync page?

Expected Behavior

• New issues created in GitHub without a Linear issue ID in their name should create a new issue in Linear linked to the GitHub issue

Current Behavior

• Creating a new issue in GitHub that is not linked to an existing Linear issue does not create a new Linear issue.

In Linear Sync, after I added a sync to test one repository, it seemed to setup fine.
But when I click the "Enable" button, I get the error:
Failed to enable issue sync (:linear_webhook_enable_failure)

Clicking "View Webhooks", no webhooks are listed for either Linear or Github.
( In Linear setting, I see a webhook created: https://linear-sync.com/webhook/linear )
( In Github, I don't see a webhook created for that repository.)

I'm not exactly sure how, but Linear's github import tool and synclinear.com both manage to append these nice, official "Github issue" links to the bottom of the Linear issue description:

By comparison, this tool only adds the link inside the rich text description. Whilst this is functionally fine, it's not quite as slick. The affordance of the button and consistent UI will make the UX this tool provides a bit nicer.

When syncing a new issue from Github to Linear, add a comment that links to the Linear issue. At the moment, a link is only created when a comment is added in Linear.

This is basically just the reverse of the

GitHub close ➡️ Linear status set to [Close Status]

sync.

Something went wrong with the Linear->Github syncing (for Github-created issues) so I tried to 'reset' the connection.

• Clicking "disable" produced this error: Failed to disable issue sync (:github_webhook_disable_failure)
  
• I tried reconnecting the Github, just in case something was going wrong there, and got an Internal Server Error
  
• When I reloaded the page, I got stuck on the login / "connect your Github" flow
  
• Somehow the view changed back to the connections page, so I tried to just delete the account, and again got an Internal Server Error.
• When I reloaded the page, I got this notice: "Failed to delete your LinearSync account, please email [email protected] for assistance."
  

I've manually removed the webhooks and plan to create a new connection with a new API key, just filing this bug in case it's helpful for smoothing things out in future. It's no problem now but if I set up 10 syncs in future and then had to manually disable and recreate them, that would be a bit of a headache.

Github has two close statuses, done and cancelled. Ideally we'd be able to map each status to a specific Linear status. In my team's Linear, we also have done and cancelled statuses.

Is it possible to turn turn off the automatic renaming of public Github issues?

I'm imaging this as a checkbox on the Configure Issue Sync page, but could also be implemented by checking for the existence of a label, like no-rename?

Linear includes a userPresentableMessage in their GraphQL error responses. It would be nice to make this user-facing in the event that there is an API failure. Error-handling in general could be better too.

Issue can be found at https://github.com/returntocorp/semgrep-action/issues/405

Steps to reproduce

1. Create new issue in GitHub
2. Set a label on the Linear ticket which exists also on GitHub
3. Verify the label is not attached to the GitHub issue

Someone previously set up Linear Sync from an account that I no longer have access to. They have revoked authorization from their Github and their Linear account has been suspended. However, now, when I try to recreate the sync using my own Github account I receive the following error message: "there is already an issue sync for this team repo combination"

Potential Solution:
Other members of a Linear workspace should be able to remove pre-existing 'syncs'

This looks really great- is there any chance the integration permissions could be reduced and exclude code, deploy keys, etc?

i created a new sync connection

• new issues are being synced and have the same data
• however existing issues do not sync to linear

What should i do to sync existing github issues into linear and keep them in sync?

Steps to reproduce:

1. Create a Github issue, see that it is synced to Linear
2. Close the synced Linear issue, see that the related Github issue has also closed
3. Change the synced Linear issue status back to "to do", see that the related Github issue remains closed

I just setup a clean account (meaning I didn't have the Linear Sync GitHub app installed before), and a sync that I created is disabled by default. When enabling, I'm getting: Failed to enable issue sync (:github_webhook_enable_failure).

I tried to peek in the code, but I'm no Elixer developer and I'm a bit confused whether GitHub webhook means it's connecting to GitHub, as the Linear API is an argument in the functions invoked there. Anyways, any idea what's happening here @jtormey?

Right now, synced comments from Linear are posted in the name of the integrating user.

To avoid confusion, the name of the Linear user should appear in the comment, either in the footer alongside "synced from Linear" or somewhere else.

Ideally, comments wouldn't be posted on behalf of the integrating user but rather by the linear-sync.com application. (e.g. so the integrating user's name and avatar doesn't show up at all for a comment that doesn't involve them.) But this is a stretch goal, I think :)

Steps to reproduce:

1. Create a Github issue, and see that it is syncing to Linear
2. Close the Github issue, and see that its status has not updated in Linear

For an issue created in Github, then synced to Linear, comment edits are not being synced either from Linear to Github or Linear to Github.

The same problem might be occurring for issues created in Linear but I can't test this before #43 is resolved.

The simplest use case for this is: if a GH issue is accidentally closed and then reopened, I'd expect the Linear ticket to not be left as "Done". A reopen feels conceptually similar to a new issue with the same content being opened, which would sync to Linear as the configured "Open Status". So I think reopens should do the same.

Hi linear-sync, thanks for this app, it's really helpful.

I have a small suggestion:

• Sync issues with assignees if they have the same primary email

Current Behavior
Every time I open a PR, a new Linear Task is opened.

Expected Behavior
I'd like to be able to set linear-sync to only open tasks with Github Issues.

Hey @jtormey! Thanks for this awesome integration. I was wondering if it's possible to only sync comments back to GitHub, when an issue has been created in GitHub and synced to Linear.

Expected Behavior

• New PRs create in GitHub without a Linear issue ID in their name should create a new issue in Linear linked to the PR
• New PRs created with a Linear issue ID should be linked to that ID
• Comments should be synced both ways between Linear and GitHub

Current Behavior

• Creating a new PR in GitHub that is not linked to an existing Linear issue does not create a new issue.
• When linking a PR to an existing Linear issue, comments from Linear are pushed to GitHub, but comments from GitHub are not pushed to Linear.