Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

One client, every forge.

`forges` is a TypeScript library for working with issues, pull requests, notifications, checks and webhooks on twelve forges: GitHub, GitLab, Bitbucket, Forgejo, Gitea, Gitee, Azure DevOps, Cursor Origin, Tangled, Pushin.eu, Sourcehut and GitBucket. A forge is a service that hosts Git repositories and the collaboration around them. It also reads repositories and their contents from Git hosts without the collaboration, such as Cloudflare Artifacts. Each provider normalises the forge's responses into one data model and declares which operations it supports.
`forges` is a TypeScript library for working with issues, pull requests, notifications, checks and webhooks on thirteen forges: GitHub, GitLab, Bitbucket, Forgejo, Gitea, Gitee, Azure DevOps, Cursor Origin, Tangled, Pushin.eu, Sourcehut, GitBucket and Upstream. A forge is a service that hosts Git repositories and the collaboration around them. It also reads repositories and their contents from Git hosts without the collaboration, such as Cloudflare Artifacts. Each provider normalises the forge's responses into one data model and declares which operations it supports.

Read the documentation at [forges.link](https://forges.link).

Expand Down
1 change: 1 addition & 0 deletions assets/providers/upstream.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/app/assets/icons/upstream.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/content/1.getting-started/1.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Every forge has its own API, with its own endpoints, its own way of authenticati

## Supported forges

`forges` supports GitHub, GitLab, Bitbucket Cloud, Forgejo, Gitea, Gitee, Azure DevOps, Cursor Origin, Tangled, Pushin.eu, Sourcehut and GitBucket. It also reads repositories and their contents from Git hosts with no issues or pull requests, such as Cloudflare Artifacts. Each of them has a [provider page](/providers) that explains how to authenticate and describes anything that behaves differently on that forge.
`forges` supports GitHub, GitLab, Bitbucket Cloud, Forgejo, Gitea, Gitee, Azure DevOps, Cursor Origin, Tangled, Pushin.eu, Sourcehut, GitBucket and Upstream. It also reads repositories and their contents from Git hosts with no issues or pull requests, such as Cloudflare Artifacts. Each of them has a [provider page](/providers) that explains how to authenticate and describes anything that behaves differently on that forge.

## What you can build

Expand Down
2 changes: 1 addition & 1 deletion docs/content/2.guides/3.environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ const forges = createForges(

## Variables

In the variable names, `<KIND>` is the name of the forge in upper case, with an underscore in place of a hyphen. That gives `GITHUB`, `GITLAB`, `BITBUCKET`, `FORGEJO`, `GITEA`, `GITEE`, `AZURE_DEVOPS`, `CURSOR_ORIGIN`, `TANGLED`, `PUSHIN`, `CLOUDFLARE_ARTIFACTS`, `SOURCEHUT` and `GITBUCKET`.
In the variable names, `<KIND>` is the name of the forge in upper case, with an underscore in place of a hyphen. That gives `GITHUB`, `GITLAB`, `BITBUCKET`, `FORGEJO`, `GITEA`, `GITEE`, `AZURE_DEVOPS`, `CURSOR_ORIGIN`, `TANGLED`, `PUSHIN`, `CLOUDFLARE_ARTIFACTS`, `SOURCEHUT`, `GITBUCKET` and `UPSTREAM`.

The following fields work for every forge. Most of them set the provider option of the same name, and the table describes what each one does:

Expand Down
80 changes: 40 additions & 40 deletions docs/content/2.guides/7.pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,46 +87,46 @@ Only the first page is conditional. A cursor with a `nextUrl` or a `token` reads

The table shows the listings whose first page carries an `etag` in a recording of the forge, and which the tests read again with it to get a page with `notModified`. Forges that aren't in the table send no ETag with their listings, or build each page from many requests, as Tangled does. GitLab's ETags are weak, and it responds `304` to them all the same.

| Listing | GitHub | GitLab | Bitbucket | Gitee |
| --- | --- | --- | --- | --- |
| `ci.jobs` | ✅ | ✅ | ❌ | ❌ |
| `ci.runs` | ✅ | ✅ | ❌ | ❌ |
| `commits.comments` | ✅ | ✅ | ✅ | ❌ |
| `commits.list` | ✅ | ✅ | ✅ | ✅ |
| `contents.branches` | ✅ | ✅ | ✅ | ✅ |
| `contents.tags` | ✅ | ✅ | ❌ | ✅ |
| `contents.tree` | ❌ | ✅ | ✅ | ❌ |
| `installations.list` | ✅ | ❌ | ❌ | ❌ |
| `installations.repos` | ✅ | ❌ | ❌ | ❌ |
| `notifications.list` | ✅ | ✅ | ❌ | ✅ |
| `orgs.teamMembers` | ✅ | ✅ | ❌ | ❌ |
| `orgs.teams` | ✅ | ✅ | ❌ | ❌ |
| `releases.list` | ✅ | ✅ | ❌ | ✅ |
| `repos.assignableUsers` | ✅ | ✅ | ❌ | ❌ |
| `repos.byOwner` | ✅ | ✅ | ✅ | ✅ |
| `repos.collaborators` | ✅ | ✅ | ❌ | ✅ |
| `repos.contributors` | ✅ | ✅ | ❌ | ✅ |
| `repos.events` | ✅ | ✅ | ❌ | ✅ |
| `repos.labels` | ✅ | ✅ | ❌ | ✅ |
| `repos.list` | ✅ | ✅ | ✅ | ✅ |
| `repos.milestones` | ✅ | ✅ | ❌ | ❌ |
| `repos.reviewerCandidates` | ✅ | ✅ | ❌ | ❌ |
| `search.code` | ❌ | ✅ | ❌ | ❌ |
| `search.commits` | ❌ | ✅ | ❌ | ❌ |
| `search.repos` | ❌ | ✅ | ✅ | ✅ |
| `search.threads` | ❌ | ❌ | ❌ | ✅ |
| `securityAlerts.list` | ✅ | ❌ | ❌ | ❌ |
| `threads.closingIssues` | ❌ | ✅ | ❌ | ❌ |
| `threads.closingPullRequests` | ❌ | ✅ | ❌ | ❌ |
| `threads.comments` | ✅ | ✅ | ✅ | ✅ |
| `threads.commits` | ✅ | ✅ | ✅ | ✅ |
| `threads.events` | ✅ | ✅ | ❌ | ❌ |
| `threads.files` | ✅ | ✅ | ✅ | ✅ |
| `threads.list` | ✅ | ✅ | ✅ | ✅ |
| `threads.reactions` | ✅ | ✅ | ❌ | ❌ |
| `users.events` | ✅ | ✅ | ❌ | ✅ |
| `webhooks.deliveries` | ✅ | ❌ | ❌ | ❌ |
| `webhooks.list` | ✅ | ✅ | ✅ | ❌ |
| Listing | GitHub | GitLab | Bitbucket | Gitee | Upstream |
| --- | --- | --- | --- | --- | --- |
| `ci.jobs` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `ci.runs` | ✅ | ✅ | ❌ | ❌ | ✅ |
| `commits.comments` | ✅ | ✅ | ✅ | ❌ | ❌ |
| `commits.list` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `contents.branches` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `contents.tags` | ✅ | ✅ | ❌ | ✅ | ✅ |
| `contents.tree` | ❌ | ✅ | ✅ | ❌ | ❌ |
| `installations.list` | ✅ | ❌ | ❌ | ❌ | ❌ |
| `installations.repos` | ✅ | ❌ | ❌ | ❌ | ❌ |
| `notifications.list` | ✅ | ✅ | ❌ | ✅ | ✅ |
| `orgs.teamMembers` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `orgs.teams` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `releases.list` | ✅ | ✅ | ❌ | ✅ | ✅ |
| `repos.assignableUsers` | ✅ | ✅ | ❌ | ❌ | ✅ |
| `repos.byOwner` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `repos.collaborators` | ✅ | ✅ | ❌ | ✅ | ❌ |
| `repos.contributors` | ✅ | ✅ | ❌ | ✅ | ❌ |
| `repos.events` | ✅ | ✅ | ❌ | ✅ | ✅ |
| `repos.labels` | ✅ | ✅ | ❌ | ✅ | ✅ |
| `repos.list` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `repos.milestones` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `repos.reviewerCandidates` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `search.code` | ❌ | ✅ | ❌ | ❌ | ✅ |
| `search.commits` | ❌ | ✅ | ❌ | ❌ | ❌ |
| `search.repos` | ❌ | ✅ | ✅ | ✅ | ✅ |
| `search.threads` | ❌ | ❌ | ❌ | ✅ | ❌ |
| `securityAlerts.list` | ✅ | ❌ | ❌ | ❌ | ❌ |
| `threads.closingIssues` | ❌ | ✅ | ❌ | ❌ | ❌ |
| `threads.closingPullRequests` | ❌ | ✅ | ❌ | ❌ | ❌ |
| `threads.comments` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `threads.commits` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `threads.events` | ✅ | ✅ | ❌ | ❌ | ❌ |
| `threads.files` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `threads.list` | ✅ | ✅ | ✅ | ✅ | ✅ |
| `threads.reactions` | ✅ | ✅ | ❌ | ❌ | ✅ |
| `users.events` | ✅ | ✅ | ❌ | ✅ | ❌ |
| `webhooks.deliveries` | ✅ | ❌ | ❌ | ❌ | ❌ |
| `webhooks.list` | ✅ | ✅ | ✅ | ❌ | ✅ |

The activity feeds of Tangled are conditional too, with an `etag` that the provider computes; see [Activity feeds](/providers/tangled#activity-feeds). A page has no `etag` in these cases, so every read of it is a full read:

Expand Down
1 change: 1 addition & 0 deletions docs/content/4.providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ A provider is what connects `forges` to one particular forge. It translates the
| [Sourcehut](/providers/sourcehut) | `forges/sourcehut` | `sourcehut()` |
| [Entire](/providers/entire) | `forges/entire` | `entire()` |
| [GitBucket](/providers/gitbucket) | `forges/gitbucket` | `gitbucket()` |
| [Upstream](/providers/upstream) | `forges/upstream` | `upstream()` |
::
<!-- capabilities:end -->

Expand Down
Loading