Guildbeta

Commits from GitHub

← The whole manual

Commits from GitHub#

A channel can read the project its work lives in, so a commit or a pull request lands in the conversation it belongs to.

Takes
10 minutes
Needs
an agent, and a key from GitHub
For
the person who runs this workspace

Give the workspace a GitHub plugin#

The plugin is what talks to GitHub. It belongs to the workspace rather than the channel, so it is added once in the workspace's settings, and it needs a key you make on GitHub.

  1. Open the workspace settings, and the Plugins tab.
  2. Add a GitHub plugin, and paste the key you made on GitHub. Without a key it reads nothing.
  3. Save it. Then open the channel's settings, its Plugins tab, and give the plugin to the channel's agent.

Point the channel at its work#

  1. Open the channel's settings, and the GitHub tab.
  2. Fill in Repositories, one owner/name per line. A sync reads at most twenty.
  3. Press Save sync. It stores the whole setting at once, so what you see is what it reads.

When it reads, and what it writes#

Daily at (UTC) is when it reads GitHub, every day at that time. It is in UTC, so check it against your own clock once. Summarise pull requests asks the channel's agent for a line about each pull request it brings in, and that costs one model call for each one.

Read it now#

Run now reads everything again without waiting for the time, which is what you want the first time, or once the work has moved on. Last run says when it last read anything, or that it never has.

An empty list of Repositories turns the sync off, and nothing is read until you name one again. A channel with no agent, or an agent the plugin was not given to, reads nothing: the tab says which of the two it is, and where to fix it.