Skip to content

GitHub, Linear and Jira ​

Customers often write in about a bug your engineers already know about. Connect your issue tracker and a draft can say whether a problem is known and whether it is still open, and with GitHub, which release fixed it. Overdesk reads only the repositories, teams or projects an admin approves.

What each one reads ​

GitHubLinearJira
ReadsOpen and closed issues, and published releasesIssuesIssues
FromThe repositories you list, as owner/nameThe teams you list, by team keyThe projects you list, by project key
CredentialA fine-grained token with read access to Metadata, Contents and IssuesA personal API key; scope it to those teams, with Read accessAn Atlassian API token, with the email of the account that created it

A team or project key is the prefix on your issue numbers, like ENG in ENG-123. Each connection holds up to 20 repositories, teams or projects.

Every issue carries its status, so a draft can tell open from closed. GitHub pull requests are left out. Jira keeps your team's own resolution word for word, so an issue closed as a duplicate never reads as fixed, and Linear says plainly when something was cancelled rather than fixed. Jira Server and Data Center are not supported.

Issues your team did not write ​

Two kinds of issue join the knowledge base without their report:

  • An issue Overdesk opened, from a conversation or a finding. Its description was written from what customers said, and nobody has checked it. A draft can still say the bug is known and whether it is open, but it never answers from that description.
  • An issue opened on a public GitHub repository by someone outside your team. Anyone can open an issue on a public repository, so Overdesk reads the report only when its author is an owner, member or collaborator of the repository. For anyone else it keeps the issue's number and status, and stores the title they gave it as their words, not your team's.

Every other issue is read in full, including every issue in a private repository. Overdesk checks whether each repository is public on every sync, so a repository made public is handled from its next sync.

Comments your team wrote ​

An issue's entry also carries the newest comments your team wrote on it, up to three, each cut to five hundred characters, so a draft can say what your team has found since the report. Comments from bots and apps, from people outside your team, and any that Overdesk wrote itself are left out.

  • On GitHub, your team is the repository's owner, members and collaborators. A comment posted by a bot, or through a GitHub App on someone's behalf, is left out even when its author is on the team.
  • On Linear, your team is the people in your workspace. Overdesk reads an issue's five most recent comments and keeps the newest three that your team wrote, leaving out bots, external users bridged in from other tools, Linear apps and integrations, guest seats, and comments Overdesk wrote. An issue whose five most recent comments include none from your team shows none.

An issue that is withheld from the knowledge base, as described above, gets no comments either.

Connect ​

  1. Open Integrations and choose GitHub, Linear or Jira.
  2. Create the credential the form asks for, following its instructions, and paste it in.
  3. List the repositories, teams or projects to read, one per line.
  4. Select Connect.

Each form checks the credential with a real read before saving it. GitHub refuses a classic token, because it can push code to every repository you can reach. The Jira form also has a checkbox for opening issues from conversations, and it stays off unless you tick it.

Only what an admin approves ​

The list on the connect form is the boundary. Overdesk reads the repositories, teams or projects on it and nothing else the credential can reach, and every sync checks the list again.

To change the list without reconnecting, open the integration's page and edit Which repositories should Overdesk read?, Which teams should Overdesk read? or Which projects should Overdesk read?. Removing an entry removes its issues from the knowledge base and stops your team filing new issues into it. Nothing in GitHub, Linear or Jira is touched.

GitHub and your code ​

Your code is never added to the knowledge base. Overdesk indexes each approved repository's file list and README, and while it writes a draft it can open files from that repository when the answer depends on what the code does.

When the customer says which version of your product they run, or their account in a connected store shows it, Overdesk is instructed to read your code as it was tagged in that release, so the answer matches the code the customer has rather than code not yet released. If that version has no release tag, Overdesk reads the default branch instead and says so.

A draft that read code lists the files under Read from your code on its What this answer is based on card, so the reviewer can check them. A draft that arrives as an internal note also names them on its "Read from the code" line, with the release each file was read at and the lines the answer rests on, where it has them. Before such a reply can go out on its own, Overdesk's own reviewer reads the same files (Rules). Overdesk is instructed not to quote code in a reply.

Opening issues from a conversation ​

The one thing Overdesk writes to these tools is a new issue opened from a conversation, and a person confirms each one. See Creating issues from a conversation.

Syncing and your plan ​

Issues sync every night. An admin can start a sync at any time with Sync now on the integration's page, where the Syncing card also shows when each sync last ran and any error it hit. Disconnecting removes everything the integration put in the knowledge base.

Each repository, team and project counts as its own knowledge source. See Plans and pricing.