opencode-telegram-bridge 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -27
- package/docs/release.md +16 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,22 @@ Run a Telegram bot that forwards messages to an OpenCode backend and returns res
|
|
|
7
7
|
- OpenCode CLI installed and available on PATH
|
|
8
8
|
- OpenCode server running (`opencode serve`)
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Install (for users)
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g opencode-telegram-bridge
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Run:
|
|
16
|
+
```bash
|
|
17
|
+
opencode-telegram-bridge
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
You still need OpenCode running separately:
|
|
21
|
+
```bash
|
|
22
|
+
opencode serve
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Develop (for contributors)
|
|
11
26
|
1. Install dependencies:
|
|
12
27
|
|
|
13
28
|
```bash
|
|
@@ -32,31 +47,5 @@ opencode serve
|
|
|
32
47
|
npm run dev
|
|
33
48
|
```
|
|
34
49
|
|
|
35
|
-
## Install via npm
|
|
36
|
-
```bash
|
|
37
|
-
npm install -g opencode-telegram-bridge
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Run:
|
|
41
|
-
```bash
|
|
42
|
-
opencode-telegram-bridge
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
You still need OpenCode running separately:
|
|
46
|
-
```bash
|
|
47
|
-
opencode serve
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## Docs
|
|
51
|
-
- `docs/index.md`
|
|
52
|
-
- `docs/installation.md`
|
|
53
|
-
- `docs/configuration.md`
|
|
54
|
-
- `docs/usage.md`
|
|
55
|
-
- `docs/systemd.md`
|
|
56
|
-
- `docs/release.md`
|
|
57
|
-
|
|
58
50
|
## Releases
|
|
59
51
|
This project uses Changesets. See `docs/release.md`.
|
|
60
|
-
|
|
61
|
-
## Notes
|
|
62
|
-
- Project aliases and chat project selection are stored in `~/.opencode-telegram-bridge/projects.db`.
|
package/docs/release.md
CHANGED
|
@@ -23,6 +23,22 @@ npm run release
|
|
|
23
23
|
|
|
24
24
|
The `prepublishOnly` script runs the build to ensure `dist/` is included.
|
|
25
25
|
|
|
26
|
+
## Automated releases (GitHub Actions)
|
|
27
|
+
This repository ships a release workflow that:
|
|
28
|
+
- Opens a release PR when changesets are present.
|
|
29
|
+
- Publishes to npm when that PR is merged.
|
|
30
|
+
- Creates a GitHub release tagged with the published version.
|
|
31
|
+
|
|
32
|
+
### Required setup
|
|
33
|
+
- Configure npm Trusted Publishing for this repo and workflow file (`release.yml`).
|
|
34
|
+
- The workflow requires `id-token: write` permission to publish via OIDC.
|
|
35
|
+
- npm CLI 11.5.1+ is required for trusted publishing.
|
|
36
|
+
|
|
37
|
+
### Flow
|
|
38
|
+
1. Merge changes with a changeset into `main`.
|
|
39
|
+
2. The workflow opens a release PR with version + changelog updates.
|
|
40
|
+
3. Merge the release PR to publish and create the GitHub release.
|
|
41
|
+
|
|
26
42
|
## CI enforcement
|
|
27
43
|
CI fails if a relevant code change lands without a `.changeset/*.md` file.
|
|
28
44
|
Docs-only updates (`docs/`, `README.md`, `.github/`) do not require a changeset.
|