Gitee

The Gitee provider covers gitee.com through the Gitee Open API v5. It reads and writes issues and pull requests. It also covers notifications, releases, repository contents, check runs and repository webhooks. The provider doesn't cover the enterprise edition (e.gitee.com).

Authentication

The provider accepts a personal access token or an OAuth access token. It sends the token in an Authorization: token <token> header, so the token doesn't appear in URLs:

import { gitee } from 'forges/gitee'

const forge = gitee({
  auth: { type: 'token', token: process.env.GITEE_TOKEN! },
}).create()

Without auth, the provider makes anonymous public reads.

Instance

The instance is gitee.com. baseUrl defaults to https://gitee.com, and the provider appends /api/v5.

Issue numbers and states

Issue numbers are alphanumeric, such as I8ABCD. Pull request numbers are integers.

A Gitee issue is open, progressing, closed or rejected. The provider maps these states as follows:

• progressing issues are open, so a listing of open issues includes them.
• rejected issues are closed, with stateReason: 'not_planned'.

Assignees and reviewers

On Gitee, the reviewers of a pull request are stored as its assignees. The provider reports them in thread.reviewers, and requestReview() sets them. An issue has a single assignee, so assigning more than one user rejects.

Merging

Gitee doesn't report which merge methods a repository allows, so merge() requires method. Without it, the call throws MergeMethodRequiredError. whenChecksPass is unavailable.

Reviews

Gitee records an approval, but it has no endpoint to read reviews. threads.reviews() is unavailable, and createReview() accepts the approve event only.

Latest release

The release that Gitee marks as latest can be a prerelease. releases.latest() returns the newest release that isn't a prerelease.

Search

search.threads() searches issues only. A search with kind: 'pull_request' returns an empty page with a kind_unsupported warning.

Webhooks

Set webhookSecret to the hook's password or signing secret:

const forge = gitee({
  webhookSecret: process.env.GITEE_WEBHOOK_SECRET,
}).create()

const events = await forge.webhooks.ingest({
  headers: request.headers,
  body: await request.text(),
})

Gitee sends the password or the signature in X-Gitee-Token, and the provider accepts either one:

• In password mode, X-Gitee-Token contains the password.
• In signing mode, X-Gitee-Token contains the URL-encoded base64 HMAC-SHA256 of <X-Gitee-Timestamp>\n<secret>. The signature covers the timestamp but not the body. The provider rejects timestamps more than one hour from the current time.

Webhook management works on repositories only. Gitee has no delivery log, so webhooks.deliveries() and webhooks.redeliver() are unavailable.

Recording fixtures

GITEE_TOKEN=... FIXTURE_GITEE_REPO=owner/repo FIXTURE_GITEE_PULL=1 \
pnpm record-fixtures gitee

To add an issue, set FIXTURE_GITEE_ISSUE.

Capabilities

Generated by pnpm capability-matrix; do not edit by hand.