HyoNovaDocumentation

GitHub

Connect GitHub read-only — link repositories to projects and issues and pull requests to tasks, see their state in HyoNova, and know what the GitHub App can and cannot read.

Requires setupBuilt, but works only after a supporting service is configured for your workspace.GuideFor: Owners, Admins, Managers, Employees, IT & security, DevelopersLast updated: Introduced:
On this page

HyoNova must set up its GitHub App before a company can install it.

The GitHub integration shows the state of your engineering work next to the work it belongs to. You link repositories to projects, and issues and pull requests to tasks; HyoNova shows whether each is open, closed, merged or in review. It is read-only: "Code stays on GitHub."

What the GitHub App can read#

You install a GitHub App, and you choose on GitHub which repositories it may read.

The app canThe app cannot
Read repository names and basic details (for example private or archived)Read code, files, commits or diffs
Read issues and pull requests in the repositories you chose: title, number, state, review state, assignees and last updateCreate, edit, comment on, close or merge anything
Receive GitHub's notices when a linked issue or pull request changesRead repositories you did not add to the installation

"HyoNova reads issue and pull request titles and states only; it never reads code and cannot change anything."

HyoNova stores only the issues and pull requests that someone linked to a task, not everything in the repository.

Show technical details

The app's repository permissions are Metadata: Read-only, Issues: Read-only and Pull requests: Read-only. It has no organization or account permissions. It subscribes to the events for issues, pull requests, pull request reviews and repositories. Events are signed by GitHub and checked by HyoNova before they are applied; each one is applied once, and a late event never replaces a newer state.

Connect GitHub#

  1. Open the card. Go to Company administration › Integrations and open GitHub.
  2. Choose Install the HyoNova GitHub App. HyoNova takes you to GitHub.
  3. Choose the account and the repositories. On GitHub, pick your organization or account, then all repositories or only the ones you select.
  4. Come back. GitHub returns you to HyoNova, which confirms with GitHub that you really own the installation before it records it.

A company has one GitHub connection, and a GitHub installation belongs to one HyoNova company.

If the installation does not finish#

MessageWhat to do
GitHub says this installation is not yours. Install the app from the account that owns it.Sign in to GitHub as a person who can see the installation
GitHub did not confirm who installed the app. Start the installation again from here.Start again from the GitHub card in HyoNova, not from GitHub
This GitHub installation is already connected to another HyoNova company.Disconnect it there first, or install the app on another account
An owner of the GitHub organization must approve the installation first. Start again after they approve.Ask an organization owner to approve the request on GitHub
This company already has a GitHub connection. Disconnect it before connecting another account.Disconnect the current connection first

The GitHub card#

After connecting, the card shows the GitHub account, the Repositories the app can read — marked Private or Archived where that applies — and for each one its Linked projects, or Not linked to a project.

  • Sync now re-reads the repositories and the linked items from GitHub. Last sync shows when that last happened.
  • To add or remove repositories, change the app's installation on GitHub. A repository the app can no longer read is marked No longer accessible.
  • If the card reads The app has no repository yet, add repositories to the installation on GitHub.

Open a project and select the GitHub tab. Choose Link a GitHub repository, then Choose a repository. A project can have several repositories, and a repository can serve several projects.

The tab then shows the linked repositories with Open on GitHub, the counts Open issues linked and Open pull requests linked, and the list Linked issues and pull requests from the project's tasks. Unlink repository removes the link.

You need permission to edit projects. If GitHub is not connected yet, the tab reads GitHub is not connected for this company yet.

Open a task and select its GitHub tab.

  1. Choose Link an issue or pull request.
  2. Pick the repository and the kind: Issue or Pull request. The list offers the repositories linked to the task's project; a task without a project, or whose project has no repository yet, can use any repository the app can read.
  3. Search by title or number and choose the item.

The task then shows each linked item with its number and title, its state — Open, Closed, Merged or Draft — a pull request's review state (Approved, Changes requested or Reviewed), who it is Assigned to on GitHub and when it was Updated. Select it to open it on GitHub. Remove link unlinks it from the task.

You need permission to edit tasks.

A merged pull request does not close a task#

HyoNova never changes a task because of something that happened on GitHub. When a linked pull request is merged, the task reads: "This pull request is merged. The task stays as it is until you change it." Complete the task is offered next to it, and a person decides.

The same holds the other way round: completing a task in HyoNova changes nothing on GitHub.

How current the state is#

GitHub tells HyoNova when a linked issue or pull request changes. As a safety net, HyoNova also re-reads open linked items it has not heard about for a day, and Sync now does it on request. If the card reads Delayed or Connection error, the states shown may be older than what GitHub shows.

Pause and disconnect#

  • Pause and Resume stop and restart the connection without removing it.
  • Disconnect makes HyoNova forget the installation. Linked repositories, issues and pull requests stay listed in HyoNova and are marked as disconnected until you remove them.

Disconnecting in HyoNova changes nothing on GitHub. To remove the app there as well, uninstall it in your GitHub account's or organization's settings. You can also narrow the app's repositories there at any time.

Limits#

Your plan can limit the number of repositories. When a limit applies, the card shows how much is used.

What this does not do#

  • It does not read or show code.
  • It does not create issues, comment, or change anything on GitHub.
  • It does not close, complete or move tasks automatically.
  • It does not import every issue of a repository: only the ones you link.

Status#

FeatureStatusNotes
GitHubRequires setupBuilt, but works only after a supporting service is configured for your workspace.Link repositories to projects, and issues and pull requests to tasks, read-only. A merged pull request never closes a task by itself.
HyoNova must set up its GitHub App before a company can install it.
Integration HubBetaWorks today in early-access workspaces. Behaviour and limits may still change.One page in Company administration for the tools your company connects, each card showing what is really connected.
↑↓ to navigate · Enter to open · Esc to close