Haruno Knowledge base

Reading GitHub

With a Git connection to a GitHub repository, Haruno can read its issues, pull requests, reviews and releases, and search them. It cannot change anything. The Git connector is no longer offered to new customers.

  • Mac appNot availableThe Mac app has no GitHub connector.
  • Windows appNot availableThe Git connector is hidden from the catalog for new customers. Only people who already have it installed keep these tools.
Not offered to new customers

The Git connector is hidden from the list of connectors for new customers. People who already have it installed keep it, and these tools keep working for them. Do not offer this to a customer who does not have the Git connector already.

Haruno can look up what is going on in a GitHub repository without a copy of it on your PC. It reads through a Git connection you already made, so it does not need a clone.

What Haruno can read

  • Issues, newest updated first, and one issue with its labels, people and text.
  • The conversation on an issue or a pull request.
  • Pull requests, with their branches and whether they were merged, and one pull request with how much it changed.
  • What reviewers said on a pull request: each verdict, such as approved or changes requested, and the notes left on the code.
  • Releases, and what shipped in one version.
  • A search of the repository's issues and pull requests.

Haruno only reads. It cannot comment, label, close or change anything on GitHub.

Reading does not show a card, because a read changes nothing.

What limits it

  • One repository per connection. Haruno reads the repository the connection names. It cannot look at another one, and a search that names another repository is refused.
  • GitHub only. A connection to GitLab or Bitbucket is refused, and the message names which site it is.
  • Public repositories need no token. They are read without signing in.
  • A private repository needs the right token. The token of the connection needs read access to issues and pull requests, not only to the code. Without it, Haruno says the token may not be able to read the issues, instead of saying the issue does not exist.
  • Not GitHub Enterprise Server. Only github.com is supported.

What to expect in an answer

  • Long text is cut. An issue or pull request body is cut at 20,000 characters, and a comment or release note at 4,000. Haruno is told how much is missing.
  • Results come in pages. A full page can mean there is more, and Haruno can ask for the next one.
  • Rate limits are GitHub's. When one is reached, the message says which. Search has a much smaller allowance, about 30 searches a minute, than the other reads.
  • Issues include pull requests. GitHub lists them together, and each row says which it is.
What to tell a customer

If Haruno says it cannot read the issues of a private repository, check the token of the Git connection first. It needs read access to issues and pull requests.

Last updated · PR #2944 · View this version on GitHub

History (1 version)
  1. Internal knowledge base for staff: site, reader keys, assistant, 197 pages and the PR rule (#2944)
    PR #2944Commit a2a7836The page at this version
    What changed
    @@ -0,0 +1,50 @@
+---
+title: Reading GitHub
+summary: With a Git connection to a GitHub repository, Haruno can read its issues, pull requests, reviews and releases, and search them. It cannot change anything. The Git connector is no longer offered to new customers.
+feature: github-reads
+covers:
+  - windows-client/docs/github-api-reads.md
+  - Integrations/git/Source/GitHubApi.cs
+  - Integrations/git/Source/GitHubApiTools.cs
+  - Integrations/git/Source/GitHubRepository.cs
+  - Integrations/git/Source/GitHubRequests.cs
+  - Integrations/git/toolsets.json
+---
+
+<Callout variant="warning" title="Not offered to new customers">
+The Git connector is hidden from the list of connectors for new customers. People who already have it installed keep it, and these tools keep working for them. Do not offer this to a customer who does not have the Git connector already.
+</Callout>
+
+Haruno can look up what is going on in a GitHub repository without a copy of it on your PC. It reads through a Git connection you already made, so it does not need a clone.
+
+## What Haruno can read
+
+- **Issues**, newest updated first, and one issue with its labels, people and text.
+- **The conversation** on an issue or a pull request.
+- **Pull requests**, with their branches and whether they were merged, and one pull request with how much it changed.
+- **What reviewers said** on a pull request: each verdict, such as approved or changes requested, and the notes left on the code.
+- **Releases**, and what shipped in one version.
+- **A search** of the repository's issues and pull requests.
+
+Haruno only reads. It cannot comment, label, close or change anything on GitHub.
+
+Reading does not show a card, because a read changes nothing.
+
+## What limits it
+
+- **One repository per connection.** Haruno reads the repository the connection names. It cannot look at another one, and a search that names another repository is refused.
+- **GitHub only.** A connection to GitLab or Bitbucket is refused, and the message names which site it is.
+- **Public repositories need no token.** They are read without signing in.
+- **A private repository needs the right token.** The token of the connection needs read access to issues and pull requests, not only to the code. Without it, Haruno says the token may not be able to read the issues, instead of saying the issue does not exist.
+- **Not GitHub Enterprise Server.** Only github.com is supported.
+
+## What to expect in an answer
+
+- **Long text is cut.** An issue or pull request body is cut at 20,000 characters, and a comment or release note at 4,000. Haruno is told how much is missing.
+- **Results come in pages.** A full page can mean there is more, and Haruno can ask for the next one.
+- **Rate limits are GitHub's.** When one is reached, the message says which. Search has a much smaller allowance, about 30 searches a minute, than the other reads.
+- **Issues include pull requests.** GitHub lists them together, and each row says which it is.
+
+<Callout variant="tip" title="What to tell a customer">
+If Haruno says it cannot read the issues of a private repository, check the token of the Git connection first. It needs read access to issues and pull requests.
+</Callout>