hotln 0.1.0

File bug reports to Linear from distributed applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# hotline

A Rust library for filing bug reports to [Linear](https://linear.app) from
distributed applications. Supports calling the Linear API directly or going
through a proxy server that holds the API key.

## Usage

```rust
// Via proxy (recommended for distributed binaries)
hotln::proxy("https://your-worker.example.com")
    .create_issue("crash on startup", Some("details..."), &[("OS", "macos")])?;

// Direct
hotln::direct("lin_api_...", "team-id", "project-id")
    .create_issue("crash on startup", Some("details..."), &[("OS", "macos")])?;
```

## Proxy protocol

The client POSTs JSON to the proxy URL. The proxy creates the issue on Linear
and returns the URL.

### Request

```typescript
interface Request {
  title: string;        // Issue title
  description: string;  // Formatted markdown body
}
```

### Response

```typescript
interface Response {
  url: string; // URL of the created Linear issue
}
```

## Worker

A reference proxy implementation lives in `worker/`. It's a Cloudflare Worker
that holds the Linear API key as a secret, rate limits by IP, and only exposes
issue creation.

```
cd worker
npm install
wrangler secret put LINEAR_API_KEY
wrangler secret put LINEAR_TEAM_ID
wrangler secret put LINEAR_PROJECT_ID
wrangler deploy
```