Following and notifications
Following repositories and organizations, the Following page, the notifications inbox, and Explore.
Follow a repository or an organization to hear what happens in it. What you follow is listed under Following in the sidebar, and what happened is in your notifications, behind the bell at the top of every page.
Following#
- A repository: Follow, beside Fork at the top of its page or in a list of repositories. You can follow any repository you can read. Each shows how many follow it.
- An organization: Follow on its page. You can follow any organization.
- Stopping: Unfollow in the same place, or on the Following page.
- Signed out, Follow signs you in first. Following is for people in the web app: tokens, agents and apps can't follow anything.
A repository you can no longer read (it was made private, or you lost access) drops out of what you follow, and you hear nothing more from it until you can read it again.
The Following page#
Following (/following) has two tabs:
- Repositories: those you follow and can read, as in any list of repositories: find them by name or description, sort them by name or by last push, and filter them by topic. 30 at a time.
- Organizations: those you follow, newest first, each with its picture, bio and how many of its repositories you can read. Find them by name or bio.
Each has Unfollow at the right.
Notifications#
Notifications (/notifications, the bell) lists, newest first:
| In a repository you follow | In an organization you follow |
|---|---|
| a push to its default branch, with how many commits | a new repository, made or forked into it |
| a change opened, merged or closed | |
| a workflow run that failed |
You're also told when a run waits for your review to deploy to an environment where you're one of the required reviewers, whether or not you follow the repository (unless you set the run off and the environment has Prevent self-review on).
- Not your own: you aren't told about what you did yourself, or an agent did for you. A failed run is the exception: you hear of it even if you set it off.
- Only what you can read: a notification from a repository you can no longer read isn't shown.
- Unread ones have a dot and are in bold, and the bell has a dot while any are unread. Opening one marks it read and takes you to the push's commits, the change, the run or the repository. Mark all as read marks the rest.
Explore#
Explore (/explore) lists every repository you can read, public ones included, with the same search, sorting and topic filter. Signed out, it's where the public repositories are: the sidebar's Repositories goes there. Follow and Fork are on each row.
The API#
These need a web session: tokens, agents and apps can't use them.
PUT, DELETE /repos/{owner}/{name}/follow | follow or stop following a repository; returns following and followers |
PUT, DELETE /orgs/{org}/follow | follow or stop following an organization |
GET /me/following | what you follow: orgs (with picture, bio, repositories you can read, followers) and repos |
GET /repos?affiliation=following | the repositories you follow, with q, topic and sort as for any list (this one works with any credential) |
GET /me/notifications?unread= | your notifications, newest first; unread=true for unread ones only |
POST /me/notifications/{id}/read, POST /me/notifications/read | mark one read; mark all read. Both return how many are still unread |