Custom development GitHub App

A read-only GitHub App that never reads your code

Clarkes.Team Portal is a GitHub App made by Clarkes.Team. It lets your client portal report on the development work done in your repositories — what was merged, updated, released, deployed and fixed.

Every permission it has is read-only. It cannot push code, open or merge pull requests, change settings, or write anything at all to GitHub. It checks for new activity on a schedule, about once an hour, and receives nothing from GitHub in between.

There is no install button on this page. The App is installed from a link tied to one GitHub account, which we send to an owner of your organization.

  • Read-only

    Access

  • About hourly

    Checks for new activity

  • An org owner

    Installed by

  • Any time

    Removable

Start here

Do you need to install anything?

It depends on one thing only: whose GitHub organization your code lives in.

Your code is in your own GitHub organization

Then yes, the App is needed.

Installing it is the only way the portal can see the work done in repositories you own. An owner of your GitHub organization installs it, choosing which repositories it may see.

If you are a member of the organization but not an owner, GitHub lets you request the install from the same screen, and an owner then approves it.

Your code is in a Clarkes.Team GitHub organization

Then no, there is nothing for you to install.

Where we build and hold the repositories ourselves, we connect them from our side. You do not need to do anything, and nothing is asked of your GitHub account.

Not sure which of the two applies to you? Ask, and we will tell you which repositories are where.

What it is for

What you will see in your portal

Five monthly figures on your application’s page, counted from the activity in the repositories you connect.

Pull requests merged

Development work merged by the Clarkes.Team team.

Dependency updates merged

Library and package updates reviewed and merged by the Clarkes.Team team.

Releases

The releases published from the repositories we work on.

Deployments

How many times the application was deployed.

Vulnerabilities resolved

Security alerts GitHub has marked as fixed.

Worth knowing

  • Each month’s figures are reviewed and approved by Clarkes.Team before they appear in your portal.
  • The first summary appears after the first month closes, so a connection made mid-month has nothing to show until that month ends.
  • Contacts with security access can also see the security alerts that are currently open.
  • Where GitHub code scanning is switched on for a repository, its findings appear alongside those security alerts. If it is not switched on, nothing changes for that repository.
  • Monthly development reporting is new. This page describes what the connection is for, and does not commit to a date for it.
The exact permissions

Six permissions, all of them read-only

This is the whole list. It is what GitHub will show you on the install screen, and there is nothing else behind it.

Every permission the Clarkes.Team Portal GitHub App requests, the access level it is granted, and why it is needed
GitHub permission Access Why it’s needed
Metadata Read-only Required by GitHub for every App. Repository names, default branch, and whether a repo is private or archived.
Pull requests Read-only To count merged pull requests: their number, title, author, who merged them, branch names and dates.
Dependabot alerts Read-only To count security alerts resolved: the affected package, severity, advisory ID and dates.
Contents Read-only GitHub puts Releases under this permission. The portal uses it only to read release tags and dates.
Actions Read-only To count deployments and spot failing builds. The portal reads the list of workflow runs and their jobs only, never build logs or build files.
Code scanning alerts Read-only To include code-level security findings in your security summary, where GitHub code scanning is switched on. The portal records the type of finding, its severity and dates, never the file or line it points to.

Why Contents is on that list

On GitHub, Contents is the permission that could technically read the files in a repository. It is on the list for one reason: GitHub files Releases under it, and there is no narrower permission that covers a release tag.

The portal only ever makes a fixed set of requests — pull requests, security alerts, releases. It never requests file contents, code, diffs or downloads. The permission GitHub grants is broader than the use we make of it; the use is not.

And why Actions is

Actions is the same shape of answer. On GitHub it could technically read your build logs and download the files a build produces.

The portal only ever requests the list of workflow runs and their jobs — enough to count deployments and see that a build failed. It never requests a log and never downloads a build file.

The other half of the list

What it never reads or stores

None of the following is requested from GitHub, and none of it is kept anywhere.

  • Your code
  • Diffs, or the contents of a change
  • Commit messages
  • Pull request descriptions or comments
  • Release notes
  • Issues
  • Secrets
  • Settings
  • Build logs
  • Build files
  • The file locations of code-scanning findings
How it works

Installing it, step by step

Three steps, and the only one on your side is the approval.

  1. 01

    We send an install link

    Clarkes.Team sends an owner of your GitHub organization a personal install link. It is tied to their GitHub account, which is why there is no install button on this page.

  2. 02

    GitHub asks the owner to approve it

    GitHub shows the App’s name and its exact read-only permissions, and asks which repositories it may see. The owner chooses the repositories and approves.

  3. 03

    The portal confirms the connection

    GitHub returns the owner to the Clarkes.Team portal, which confirms the connection. We then link the repositories to the right application in your portal.

All repositories, or only some?

At that second step GitHub asks the owner to choose between “All repositories” and “Only select repositories”.

We recommend “Only select repositories”, choosing the ones Clarkes.Team works on. The selection can be changed at any time in GitHub, so starting narrow costs you nothing.

Your control

Changing or removing access

Nothing about this is a one-way door, and none of it goes through us.

Where the controls are

In GitHub, at any time: your organization’s Settings → GitHub Apps → Clarkes.Team Portal → Configure. From there an owner can change which repositories it sees, suspend it, or uninstall it.

What happens when you do

After uninstalling or suspending, the portal stops reading anything from your organization straight away. Monthly summaries already approved stay in the portal as the record of work done.

Data retention

How long any of it is kept

Detailed activity: 24 months
The individual pull requests, alerts and releases behind the counts are deleted after 24 months.
Approved monthly summaries: kept
The approved counts are the record of the work done on your application, so they stay in the portal.
Who sees which
Raw activity details are visible to Clarkes.Team staff. In your portal you see the approved monthly figures.
Before you approve it

The questions owners ask

Can it change my code?

No. Every permission the App has is read-only. It cannot push code, open or merge pull requests, change settings, or write anything at all to GitHub. There is no permission in its list that would let it.

Does it read our code, diffs or commit messages?

No. It never requests file contents, code, diffs or downloads, and it does not read commit messages, pull request descriptions or comments, release notes, issues, secrets, settings, build logs or build files. Two permissions in its list look broader than they are: “Contents” is there because GitHub files Releases under it, and “Actions” because that is where the list of workflow runs lives. The portal uses them only to read release tags and dates, and to count deployments and failed builds.

Can I limit it to some repositories?

Yes, and we recommend it. When installing, GitHub asks whether the App may see all repositories or only selected ones. Choose “Only select repositories” and pick the ones Clarkes.Team works on. The selection can be changed at any time in GitHub.

Who has to install it?

An owner of your GitHub organization. If you are a member but not an owner, GitHub lets you request the install and an owner then approves it. You only need it at all if your code lives in your own GitHub organization — where it is in a Clarkes.Team organization, we connect it ourselves and there is nothing for you to install.

What happens if I uninstall it?

The portal stops reading anything from your organization straight away. Monthly summaries that have already been approved stay in the portal as the record of work done. Uninstalling and suspending are both done from GitHub, in your organization’s Settings → GitHub Apps → Clarkes.Team Portal → Configure.

Something not covered here? Ask an engineer

Still want to talk it through first?

Ask whatever is left — which repositories we would want to see, who in your organization has to approve it, or anything on this page you would like in writing before you decide.