codeharbor 0.1.2 → 0.1.4
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 +21 -7
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -106,8 +106,13 @@ CodeHarbor supports auto publish to npm from GitHub Actions.
|
|
|
106
106
|
|
|
107
107
|
Setup once:
|
|
108
108
|
|
|
109
|
-
1.
|
|
110
|
-
|
|
109
|
+
1. Configure npm Trusted Publishing for this repository/workflow (preferred):
|
|
110
|
+
- npm package settings -> Trusted publishing -> Add publisher
|
|
111
|
+
- Provider: GitHub Actions
|
|
112
|
+
- Repository: `biglone/CodeHarbor`
|
|
113
|
+
- Workflow file: `.github/workflows/release-npm.yml`
|
|
114
|
+
2. Optional fallback: set repository secret `NPM_TOKEN` (npm automation token).
|
|
115
|
+
3. Push to `main` with a publish trigger commit message.
|
|
111
116
|
|
|
112
117
|
Trigger rules:
|
|
113
118
|
|
|
@@ -119,17 +124,25 @@ Trigger rules:
|
|
|
119
124
|
The workflow runs `typecheck`, `test`, `test:e2e` (Admin UI Playwright), `build`, `node dist/cli.js --help`, `npm pack --dry-run`, then publishes with:
|
|
120
125
|
|
|
121
126
|
```bash
|
|
122
|
-
npm publish --access public
|
|
127
|
+
npm publish --provenance --access public
|
|
123
128
|
```
|
|
124
129
|
|
|
130
|
+
Auth mode selection:
|
|
131
|
+
|
|
132
|
+
- If `NPM_TOKEN` secret exists: publish with token.
|
|
133
|
+
- If `NPM_TOKEN` is absent: publish via npm Trusted Publishing (OIDC).
|
|
134
|
+
|
|
125
135
|
If the same package version already exists on npm, publish is skipped automatically.
|
|
126
136
|
|
|
127
137
|
Release checklist (recommended):
|
|
128
138
|
|
|
129
|
-
1. Update
|
|
130
|
-
2.
|
|
131
|
-
3.
|
|
132
|
-
|
|
139
|
+
1. Update `CHANGELOG.md` with a new version section and bullet-point release notes.
|
|
140
|
+
2. Update version in `package.json` (`npm version patch|minor|major`).
|
|
141
|
+
3. Validate changelog entry:
|
|
142
|
+
- `npm run changelog:check`
|
|
143
|
+
4. Push to `main` with `[publish-npm]` or `release vX.Y.Z` in commit message.
|
|
144
|
+
5. Verify workflow status in GitHub Actions.
|
|
145
|
+
6. Verify package on npm:
|
|
133
146
|
|
|
134
147
|
```bash
|
|
135
148
|
npm view codeharbor version
|
|
@@ -217,6 +230,7 @@ It documents:
|
|
|
217
230
|
- `codeharbor admin serve`: start admin UI + config API server
|
|
218
231
|
- `codeharbor config export`: export current config snapshot as JSON
|
|
219
232
|
- `codeharbor config import <file>`: import config snapshot JSON (supports `--dry-run`)
|
|
233
|
+
- `npm run changelog:check`: validate `CHANGELOG.md` has notes for current package version
|
|
220
234
|
- `scripts/install-linux.sh`: Linux bootstrap installer (creates runtime dir + installs npm package)
|
|
221
235
|
- `scripts/install-linux-easy.sh`: one-shot Linux install + config + systemd auto-start
|
|
222
236
|
- `scripts/backup-config.sh`: export timestamped snapshot and keep latest N backups
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codeharbor",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Instant-messaging bridge for Codex CLI sessions",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/cli.js",
|
|
@@ -57,7 +57,8 @@
|
|
|
57
57
|
"test:legacy": ".venv/bin/python -m pytest -q tests",
|
|
58
58
|
"prepare": "npm run build",
|
|
59
59
|
"prepack": "npm run build",
|
|
60
|
-
"prepublishOnly": "npm run typecheck && npm run lint && npm run test:coverage && npm run build",
|
|
60
|
+
"prepublishOnly": "npm run changelog:check && npm run typecheck && npm run lint && npm run test:coverage && npm run build",
|
|
61
|
+
"changelog:check": "bash ./scripts/check-changelog.sh",
|
|
61
62
|
"lint": "eslint .",
|
|
62
63
|
"lint:fix": "eslint . --fix",
|
|
63
64
|
"test:coverage": "vitest run test --coverage"
|