--- title: "Gitee" description: "Use gitee.com through the Gitee Open API v5: issues, pull requests, notifications, releases and webhooks." canonical_url: "https://forges.link/providers/gitee" --- # Gitee > Use gitee.com through the Gitee Open API v5: issues, pull requests, notifications, releases and webhooks. The Gitee provider works with gitee.com through the Gitee Open API v5. It can read and write issues and pull requests, and it also covers notifications, releases, repository contents, check runs and repository webhooks. The provider doesn't support the enterprise edition (`e.gitee.com`).

Detail	Value
Import	`forges/gitee`
Factories	`gitee()` , `giteeLite()`
Auth	`token` , `anonymous`

The reads of the Gitee provider are verified against recordings of the live forge, but most of its writes are not yet, so they are `'unverified'`. To learn what that means, see [Capabilities](https://forges.link/concepts/capabilities). ## Authentication The provider accepts a personal access token or an OAuth access token. It sends the token in an `Authorization: token ` header, which keeps the token out of the URLs of your requests: ```ts import { gitee } from 'forges/gitee' const forge = gitee({ auth: { type: 'token', token: process.env.GITEE_TOKEN! }, }).create() ``` If you leave out `auth`, the provider makes anonymous reads of public data. ## Instance The instance is `gitee.com`. The `baseUrl` defaults to `https://gitee.com`, and the provider appends `/api/v5` itself. ## Contributors Gitee counts commits per author email, so `repos.contributors()` returns one contributor per email, with a `name` and an `email` but no `actor`. ## Issue numbers and states Issue numbers on Gitee are alphanumeric, such as `I8ABCD`, while pull request numbers are integers. A Gitee issue is `open`, `progressing`, `closed` or `rejected`, and the provider maps these states to the shared model. An issue that is `progressing` counts as open, so a listing of open issues includes it. An issue that is `rejected` counts as 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 can only have a single assignee, so assigning more than one user rejects. ## Merging Gitee doesn't report which merge methods a repository allows, so the provider can't pick one for you. `merge()` requires a `method` and throws `MergeMethodRequiredError` without it. The `whenChecksPass` option isn't available. ## Reviews Gitee records an approval, but it has no endpoint to read reviews. As a result, `threads.reviews()` isn't available, and `createReview()` only accepts the `approve` event. ## Latest release The release that Gitee marks as the latest can be a prerelease. To avoid surprises, `releases.latest()` returns the newest release that isn't a prerelease. ## Listing an owner's repositories `repos.byOwner()` reads the repositories of an organisation first. When no organisation has that name, it reads the personal repositories of the user instead. Gitee can't sort the repositories of an organisation, so if you pass `sort` for one, you get a `sort_unsupported` warning. ## Activity feeds Without credentials, Gitee returns an empty feed for every account, so `users.events()` needs a token. `repos.events()` works either way. ## Comparing revisions Gitee returns no more than the newest 100 commits and 200 files of a comparison, so `contents.compare()` returns at most that many. When there are more than 100 commits, `aheadBy` is unset. ## Search `search.threads()` only searches issues. If you search with `kind: 'pull_request'`, you get an empty page with a `kind_unsupported` warning. ## Webhooks To verify deliveries, set `webhookSecret` to the password or the signing secret of the hook: ```ts 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 either the password or a signature in the `X-Gitee-Token` header, depending on how the hook is set up, and the provider accepts both: - In password mode, `X-Gitee-Token` contains the password. - In signing mode, `X-Gitee-Token` contains the URL-encoded base64 HMAC-SHA256 of `\n`. The signature covers the timestamp but not the body, and the provider rejects timestamps that are more than one hour away from the current time. You can manage webhooks on repositories only. Gitee doesn't keep a delivery log, so `webhooks.deliveries()` and `webhooks.redeliver()` aren't available. ## Capabilities

Capability	Support	Without credentials
`experimental`	❌	❌
`sources.poll`	✅	❌
`sources.webhook`	✅	✅
`sources.subscribe`	❌	❌
`repos.get`	✅	✅
`users.get`	✅	✅
`users.me`	✅	❌
`users.sponsorable`	❌	❌
`users.events`	unverified	❌
`repos.list`	✅	❌
`repos.byOwner`	✅	✅
`repos.labels`	✅	✅
`repos.createLabel`	unverified	❌
`repos.milestones`	❌	❌
`repos.collaborators`	✅	✅
`repos.contributors`	✅	✅
`repos.contributorStats`	❌	❌
`repos.templates`	❌	❌
`repos.permissionFor`	❌	❌
`repos.addCollaborator`	❌	❌
`repos.assignableUsers`	❌	❌
`repos.reviewerCandidates`	❌	❌
`repos.events`	✅	✅
`orgs.teams`	❌	❌
`orgs.teamMembers`	❌	❌
`threads.get`	issue, PR	issue, PR
`threads.list`	issue, PR	issue, PR
`threads.getMany`	✅	✅
`threads.events`	issue, PR	issue, PR
`comments.list`	issue, PR	issue, PR
`comments.get`	issue (emulated), PR (emulated)	issue (emulated), PR (emulated)
`comments.edit`	issue (unverified), PR (unverified)	❌
`comments.delete`	issue (unverified), PR (unverified)	❌
`reactions.list`	❌	❌
`notifications.list`	✅	❌
`notifications.markRead`	✅	❌
`notifications.markDone`	❌	❌
`notifications.unsubscribe`	❌	❌
`notifications.markAllRead`	unverified	❌
`notifications.markAllDone`	❌	❌
`notifications.unreadCount`	✅	❌
`writes.comment`	issue (unverified), PR	❌
`writes.upsertComment`	issue (unverified), PR (unverified)	❌
`writes.close`	issue (unverified), PR	❌
`writes.reopen`	issue (unverified), PR	❌
`writes.create`	issue (unverified), PR (unverified)	❌
`writes.update`	issue (unverified), PR	❌
`writes.setLabels`	issue (unverified), PR (unverified)	❌
`writes.addLabels`	issue (unverified), PR (unverified)	❌
`writes.removeLabels`	issue (unverified), PR (unverified)	❌
`writes.setMilestone`	❌	❌
`writes.react`	❌	❌
`writes.setAssignees`	issue (unverified)	❌
`writes.requestReview`	PR (unverified)	❌
`writes.merge`	✅	❌
`writes.approveAndMerge`	unverified	❌
`writes.transfer`	❌	❌
`writes.markDuplicate`	❌	❌
`subscriptions.get`	❌	❌
`subscriptions.set`	❌	❌
`installations`	❌	❌
`checks.thread`	PR	PR
`checks.list`	✅	✅
`checks.get`	❌	❌
`checks.report`	❌	❌
`checks.rerun`	❌	❌
`ci.runs`	❌	❌
`ci.run`	❌	❌
`ci.jobs`	❌	❌
`ci.job`	❌	❌
`ci.log`	❌	❌
`contents.file`	✅	✅
`contents.tree`	✅	✅
`contents.branches`	✅	✅
`contents.tags`	✅	✅
`contents.resolveRef`	✅	✅
`contents.commits`	✅	✅
`contents.commit`	✅	✅
`contents.compare`	✅	✅
`contents.commitFiles`	❌	❌
`contents.threadFiles`	✅	✅
`contents.threadCommits`	✅	✅
`reviews.list`	❌	❌
`reviews.get`	❌	❌
`reviews.create`	unverified	❌
`reviews.submit`	❌	❌
`reviews.approve`	unverified	❌
`reviews.reply`	❌	❌
`reviews.resolveThread`	❌	❌
`releases.list`	✅	✅
`releases.get`	✅	✅
`releases.latest`	✅	✅
`releases.getByTag`	✅	✅
`releases.downloadAsset`	❌	❌
`releases.create`	❌	❌
`releases.update`	❌	❌
`webhooks.list`	unverified	❌
`webhooks.create`	unverified	❌
`webhooks.update`	unverified	❌
`webhooks.delete`	unverified	❌
`webhooks.rotateSecret`	unverified	❌
`webhooks.deliveries`	❌	❌
`webhooks.redeliver`	❌	❌
`search.threads`	✅	✅
`search.repos`	✅	✅
`search.commits`	❌	❌
`search.code`	❌	❌
`securityAlerts`	❌	❌
`eventKinds`	native	native
`authKinds`	`token` , `anonymous`	`token` , `anonymous`
`limits`	unknown	unknown

## Sitemap See the full [sitemap](https://forges.link/sitemap.md) for all pages.