oca-proxy 1.0.6 → 1.0.7
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 +75 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -201,7 +201,81 @@ module.exports = {
|
|
|
201
201
|
],
|
|
202
202
|
};
|
|
203
203
|
```
|
|
204
|
-
|
|
204
|
+
|
|
205
205
|
Then start with `pm2 start ecosystem.config.js`.
|
|
206
206
|
|
|
207
|
+
## Releases (GitHub Actions)
|
|
208
|
+
|
|
209
|
+
Tagged pushes that match `v*.*.*` trigger a cross-platform build and GitHub Release with prebuilt binaries using `@yao-pkg/pkg`.
|
|
210
|
+
|
|
211
|
+
- Workflow: `.github/workflows/release.yml`
|
|
212
|
+
- Builds on: Ubuntu, macOS, Windows (Node 20)
|
|
213
|
+
- Output release assets:
|
|
214
|
+
- `oca-proxy-macos-x64.tar.gz`
|
|
215
|
+
- `oca-proxy-macos-arm64.tar.gz`
|
|
216
|
+
- `oca-proxy-linux-x64.tar.gz`
|
|
217
|
+
- `oca-proxy-linux-arm64.tar.gz`
|
|
218
|
+
- `oca-proxy-windows-x64.zip`
|
|
219
|
+
|
|
220
|
+
- How to test builds (Intel and Apple Silicon):
|
|
221
|
+
1. Manually run the workflow without tagging (GitHub → Actions → build-and-release → Run workflow).
|
|
222
|
+
2. Download artifacts for your platform from the run summary.
|
|
223
|
+
3. macOS:
|
|
224
|
+
- Intel: `chmod +x oca-proxy-macos-x64 && ./oca-proxy-macos-x64 --help`
|
|
225
|
+
- Apple Silicon: `chmod +x oca-proxy-macos-arm64 && ./oca-proxy-macos-arm64 --help`
|
|
226
|
+
- Test Intel binary on Apple Silicon via Rosetta: `arch -x86_64 ./oca-proxy-macos-x64 --help`
|
|
227
|
+
4. Linux:
|
|
228
|
+
- x64: `chmod +x oca-proxy-linux-x64 && ./oca-proxy-linux-x64 --help`
|
|
229
|
+
- arm64: `chmod +x oca-proxy-linux-arm64 && ./oca-proxy-linux-arm64 --help`
|
|
230
|
+
5. Windows:
|
|
231
|
+
- `.\oca-proxy-windows-x64.exe --help`
|
|
232
|
+
6. Optional smoke test: start the server and hit the health endpoint:
|
|
233
|
+
- `./oca-proxy-<platform-arch> &`
|
|
234
|
+
- `curl -s http://localhost:8669/health`
|
|
235
|
+
|
|
236
|
+
Cut a release:
|
|
237
|
+
|
|
238
|
+
```bash
|
|
239
|
+
# 1) Bump your version in package.json (optional but recommended)
|
|
240
|
+
# 2) Commit and tag
|
|
241
|
+
git commit -am "chore: release v1.0.5"
|
|
242
|
+
git tag v1.0.5
|
|
243
|
+
git push origin v1.0.5
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
Or using npm to manage the version and tag:
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
npm version patch # or minor/major
|
|
250
|
+
git push --follow-tags
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
## Homebrew Tap
|
|
254
|
+
|
|
255
|
+
You can distribute `oca-proxy` via a personal Homebrew tap.
|
|
256
|
+
|
|
257
|
+
1. Create a tap repo: `your-user/homebrew-tap`
|
|
258
|
+
2. Add a formula at `Formula/oca-proxy.rb` (a template exists in this repo under `Formula/oca-proxy.rb`)
|
|
259
|
+
3. After a release publishes, update the `sha256` values in the formula for each asset:
|
|
260
|
+
- `shasum -a 256 oca-proxy-macos-x64.tar.gz`
|
|
261
|
+
- `shasum -a 256 oca-proxy-linux-x64.tar.gz`
|
|
262
|
+
- `shasum -a 256 oca-proxy-macos-arm64.tar.gz` (if you publish it)
|
|
263
|
+
4. Commit the formula to your tap
|
|
264
|
+
|
|
265
|
+
Install from your tap:
|
|
266
|
+
|
|
267
|
+
```bash
|
|
268
|
+
brew tap your-user/tap
|
|
269
|
+
brew install oca-proxy
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### Automate tap updates
|
|
273
|
+
|
|
274
|
+
This repo includes `.github/workflows/brew-tap.yml` which can automatically bump your tap’s formula on every GitHub Release. Requirements:
|
|
275
|
+
|
|
276
|
+
- Create `GH_PAT` secret (Personal Access Token with `repo` scope) in this repo
|
|
277
|
+
- Ensure your tap repo is `your-user/homebrew-tap` (or adjust the workflow’s `tap:` input)
|
|
278
|
+
|
|
279
|
+
The action computes new checksums and updates URLs in `Formula/oca-proxy.rb` within your tap repository.
|
|
280
|
+
|
|
207
281
|
|