Expand description
The contract of a code host’s client (docs/PLUGINS.md §4.5): what a plugin’s client does for one account, and what
the core’s adapter of a plugin (ProcessForge) and the hosts still in the core do the same way. A call a host
cannot do says Unsupported, which crosses the protocol as « no such method » (-32601).
Structs§
- Check
- A check or a status of a pull request’s last commit (a CI job).
- Deployment
- A deployment in one of the repository’s environments.
- Identity
- Who an account is on its host, as its token says.
- Merge
Options - How a pull request of a repository may merge, as the repository’s settings say (ESC-62): the strategies they allow,
and whether the host merges by itself once the checks pass (GitHub’s « Allow auto-merge », Gitea’s protected
branch). Read by
Forge::merge_options. - Pace
- When and how long the client slows down.
- Pull
Request - A pull request as its host tells it (kept with an agent’s data:
AgentMeta::prs). - Pull
Request Draft - A pull request (a merge request on GitLab) to open.
- Rate
Limit - How much of its calls a host leaves, as its answers say.
- RepoRef
- A repository on a code host: its namespace (owner, organization, GitLab group and subgroups, Bitbucket workspace) and its name.
- Review
- Review
Comment - A comment of a pull request, on one of its lines or not.
- Review
Draft - A review to publish on a pull request, as the user validated it.
- Review
Line - A comment on a line of a review to publish.
- Unsupported
- What a host was asked and cannot do (
Capabilities), or its client does not do yet.
Enums§
- Check
State - Merge
Strategy - How a pull request merges.
- PrState
- Review
State
Constants§
- OPEN_
PRS - The most open pull requests of a repository a host lists (
forge/openPullRequests).
Traits§
- Forge
- A client of one host for one account. Its provider’s
Capabilitiessay which calls it answers; the others sayUnsupported.
Functions§
- instant
- An instant of a host’s answer (RFC 3339) in seconds since 1970; none when absent or unread.
- unsupported
Type Aliases§
- BoxFuture
- What a client’s calls give back.