Skip to content

Commit 075642b

Browse files
Add GitHub Packages workflow
1 parent 9763ec7 commit 075642b

3 files changed

Lines changed: 72 additions & 0 deletions

File tree

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Publish GitHub Package
2+
3+
on:
4+
workflow_dispatch:
5+
release:
6+
types:
7+
- published
8+
9+
permissions:
10+
contents: read
11+
packages: write
12+
13+
jobs:
14+
publish:
15+
name: Publish npm package to GitHub Packages
16+
runs-on: ubuntu-latest
17+
18+
defaults:
19+
run:
20+
working-directory: plugins/remote-ssh
21+
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Node.js
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 20
30+
registry-url: https://npm.pkg.github.com
31+
scope: "@zaintechnologiesltd"
32+
33+
- name: Install dependencies
34+
run: npm install --ignore-scripts
35+
36+
- name: Run tests
37+
run: npm test
38+
39+
- name: Publish package
40+
run: npm publish --registry https://npm.pkg.github.com
41+
env:
42+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ See [plugins/remote-ssh/README.md](./plugins/remote-ssh/README.md) for setup, se
3434
- [Architecture](./plugins/remote-ssh/ARCHITECTURE.md)
3535
- [Configuration](./plugins/remote-ssh/CONFIGURATION.md)
3636

37+
## GitHub Package
38+
39+
The npm package is published to GitHub Packages as:
40+
41+
```text
42+
@zaintechnologiesltd/codex-remote-ssh
43+
```
44+
45+
The package publishing workflow lives at:
46+
47+
```text
48+
.github/workflows/publish-package.yml
49+
```
50+
3751
## Key Features
3852

3953
- Local MCP server with no runtime npm dependencies

plugins/remote-ssh/PUBLISHING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,19 @@ Catalog install command:
4444
```bash
4545
npx codex-marketplace add ZainTechnologiesLTD/codex-remote-ssh --plugins
4646
```
47+
48+
## GitHub Packages
49+
50+
The package name is:
51+
52+
```text
53+
@zaintechnologiesltd/codex-remote-ssh
54+
```
55+
56+
Publishing is handled by:
57+
58+
```text
59+
.github/workflows/publish-package.yml
60+
```
61+
62+
Run the workflow manually from GitHub Actions or publish a GitHub release. The workflow uses the repository `GITHUB_TOKEN` with `packages: write`.

0 commit comments

Comments
 (0)