README.md · ermite-api · git.bnema.dev

Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here.

import (
	"bnema.dev/ermite-api/gen/ermite"
	"bnema.dev/ermite-api/gen/ermite/ermiteconnect"
)

The server mounts the services under /-/api/. Errors are Connect codes.
No version number: the contract only changes in backward-compatible ways, and CI rejects breaking changes (buf breaking).
Tokens carry scopes only; presets such as cli or agent are a client concern.

Status: early development.

Services

Service	Purpose
`RepoService`	repositories and their settings
`GitService`	refs, trees, blobs, commits and diffs
`TokenService`	API tokens
`MergeRequestService`	merge requests, comments, merge
`SessionService`	web sign-in links (owner only)
`EventService`	live event stream, resumable
`ServerService`	version, features, signing key, OIDC key rotation
`RunService`	CI runs, jobs, logs, checks, runners
`RunnerService`	used by CI runners to fetch and report jobs
`SecretService`, `VariableService`, `EnvironmentService`	CI settings
`ArtifactService`	CI artifacts, for people
`JobArtifactService`	CI artifacts v4, for runners
`TrustedKeyService`	SSH and OpenPGP keys commit signatures are checked against

Every RPC: docs/services.md.

Layout

proto/ermite/: one .proto per service, plus shared types.proto.
gen/ermite/: generated messages; gen/ermite/ermiteconnect/: Connect clients and handlers. Committed, never edited by hand.

buf generate

License

MIT. See LICENSE.

source

1<h1 align="center">ermite-api</h1>
2
3<p align="center">
4  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="License: MIT"></a>
5  <a href="https://github.com/bnema/ermite-api/commits/main"><img src="https://badgen.net/github/last-commit/bnema/ermite-api/main?icon=github" alt="Last commit"></a>
6  <a href="https://github.com/bnema/ermite-api/stargazers"><img src="https://badgen.net/github/stars/bnema/ermite-api?icon=github" alt="GitHub stars"></a>
7</p>
8
9<p align="center">The public API of <a href="https://github.com/bnema/ermite">ermite</a>: protobuf definitions and generated Go code for its ConnectRPC services.</p>
10
11> Read-only mirror. Development happens at git.bnema.dev; issues and pull requests are closed here.
12
13---
14
15```go
16import (
17	"bnema.dev/ermite-api/gen/ermite"
18	"bnema.dev/ermite-api/gen/ermite/ermiteconnect"
19)
20```
21
22- The server mounts the services under `/-/api/`. Errors are Connect codes.
23- No version number: the contract only changes in backward-compatible ways, and CI rejects breaking changes (`buf breaking`).
24- Tokens carry scopes only; presets such as `cli` or `agent` are a client concern.
25
26Status: early development.
27
28## Services
29
30| Service | Purpose |
31|---|---|
32| `RepoService` | repositories and their settings |
33| `GitService` | refs, trees, blobs, commits and diffs |
34| `TokenService` | API tokens |
35| `MergeRequestService` | merge requests, comments, merge |
36| `SessionService` | web sign-in links (owner only) |
37| `EventService` | live event stream, resumable |
38| `ServerService` | version, features, signing key, OIDC key rotation |
39| `RunService` | CI runs, jobs, logs, checks, runners |
40| `RunnerService` | used by CI runners to fetch and report jobs |
41| `SecretService`, `VariableService`, `EnvironmentService` | CI settings |
42| `ArtifactService` | CI artifacts, for people |
43| `JobArtifactService` | CI artifacts v4, for runners |
44| `TrustedKeyService` | SSH and OpenPGP keys commit signatures are checked against |
45
46Every RPC: [docs/services.md](docs/services.md).
47
48## Layout
49
50- `proto/ermite/`: one `.proto` per service, plus shared `types.proto`.
51- `gen/ermite/`: generated messages; `gen/ermite/ermiteconnect/`: Connect clients and handlers. Committed, never edited by hand.
52
53```sh
54buf generate
55```
56
57## License
58
59MIT. See [LICENSE](LICENSE).

README.md RawHistoryFolder

Services

Layout

License

README.md Raw History Folder