Add the GitHub cards to your dashboard

The GitHub cards of My Dashboards show what your own GitHub account sees. They need your own token, connected once — from the card itself.

The cards

Key	What it shows
Workflows	GitHub Actions workflow runs with status and run number
Detailed Workflows	Workflow runs with individual job details, stages, and duration
Pull Requests	Pull requests of every GitHub repository of the catalog that your token can read, with author, reviewers, status and your role (filter on it for your own)
Releases	The last published release of each GitHub repository of the catalog your token can read

A card with nothing to show says Nothing here yet and, under it, what would fill it:

Card	What it says
Pull Requests	No open pull request in the GitHub repositories named by the components of the catalog (github.com/project-slug annotation) that your token can read.
Workflows and Detailed Workflows	No workflow run lately in the GitHub repositories of the components you own (github.com/project-slug annotation).
Releases	No release published in the GitHub repositories named by the components of the catalog (github.com/project-slug annotation) that your token can read.

Click Learn more under the sentence to come back to this page.

➕ Add a card

1. In the left sidebar, click My Dashboards, then the tab of the dashboard you want.

2. Click Add a card, at the top of the page.

3. In Add a card, pick Source github, then a Key.

4. Leave organizations empty, or see Which repositories below.

5. Enter a Card Name, then click Add.

The github source is missing?

It is only offered once the administrator has added the GitHub integration.

🔗 Connect your GitHub account

The first time, the card says Your GitHub account is not connected. ("This card shows what your own GitHub account sees. The token set in the administration only serves the entity tabs, the catalog and Compass: connect your own GitHub account, here or in My account › My accounts.")

1. In the card, click Connect my GitHub account. The Connect my GitHub account window opens on the dashboard. It says where to create the token, with which rights (repo and read:org), and links to the token page of your GitHub.

2. Fill in:

   • Username: your GitHub login, for example octocat. Astrolabe recognises you by it in GitHub events.
   • Token: a token of your own GitHub account. See Create a GitHub token.

3. Click Test Connection. It says Connection works: the tool accepted your token.

4. Click Save. The window closes and every GitHub card of your dashboard reads again: they show what your GitHub account sees.

Your token is also listed in My Account › My accounts, where you change or remove it.

✅ That's it!

What each card shows

Each row has a coloured dot for its status; the card's top right names the statuses it contains. The arrow at the end of a row opens the item on GitHub.

Workflows

Column	What it holds
Resource	The repository
Title	The workflow
Author	Who started the run
Date	When the run was last updated

One row per workflow of each repository: its latest run, kept only if it ran in the last two hours or if it failed in the last day. A card with no such run says Nothing here yet and the sentence above.

Detailed Workflows

Column	What it holds
Resource	The repository
Title	The job
Key	The run number, like #1
Date	When the run was last updated
Duration	How long the job took, - while it has not finished
Status	queued, success, and so on
Stages	The steps of the job

Same runs as Workflows, one row per job.

Pull Requests

Column	What it holds
Resource	The repository
Key	The number of the pull request, like #44
Title	The pull request
Author	Who opened it
Assignees	Who it is assigned to, - when nobody
Reviewers	Who is asked to review it, - when nobody
My role	What you are on it: Author, Review requested, Assignee or None
Date	The pull request date

The pull requests of every repository of the catalog that your token can read, whoever opened them: the open ones, and those closed in the last 7 days. The top right of the card names the states present, open and closed. The table shows 5 rows per page; Show 10 results lists 10, and the count (for example 1-5 of 83) moves with the filter.

If GitHub holds too many pull requests to read them all, the card says List cut: too many items to read, only the most recent are shown. above the table.

Keep only your pull requests

The card lists everything your token reads. To keep yours, filter the column My role and save the filter with the card:

1. On My Dashboards, open the tab of the dashboard.

2. On the card, click more, then Edit, then open the Filters tab.

3. Under my role, click the cross of None (Remove filter None). Only the pull requests where you are involved stay: here Author.

4. Click Save in the window.

The filter is saved with the card. To see everything again, open the Filters tab and click Reset under my role. See also Change or remove a card.

Releases

Column	What it holds
Resource	The repository
Key	The tag of the release
Date	When it was published

The last published release of each repository. A repository without any release has no row.

Which repositories?

The cards only show repositories that a component of the catalog names with github.com/project-slug. A repository the catalog does not know is never shown.

The organizations field ("GitHub organizations to show, comma-separated (e.g. acme). Empty: the ones the catalog imports.") picks the organizations. Left empty, a card covers the organizations of the GitHub catalog provider. To show a component registered by hand from another organization, write that organization in the field, for example acme.

The states in My Account › My accounts

State	What it means
Connected	Your token works
Not connected	You have not saved a token
Token refused	GitHub refuses your saved token. Hover the words for the reason, or click Configure.
Not verified	GitHub could not be reached to check

🔔 Notifications

You choose what you receive in My Account › Notifications. Under GitHub, the screen lists When a workflow fails (marked as critical), When a PR is opened, When a PR is closed, When a PR is edited, When a PR review is requested, When a PR is approved, When changes are requested on a PR, When a PR is reviewed with comments and When a workflow is cancelled.

For GitHub to send them, the administrator sets a secret in Administration › Company connections › Webhooks › GitHub › Configure (Webhook Secret, then Save Secret). This step, and the delivery of the notifications, were not checked on a live instance.

Next: GitHub FAQ.