Skip to content

Commit d928750

Browse files
satish-bhamaresatish-bhamare
authored
Merge branch 'master' into satish/APPS-8078/npm-publish-workflow
2 parents 3944fbf + 52d7d0e commit d928750

26 files changed

Lines changed: 1854 additions & 270 deletions

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ jobs:
3131
./packages/zcli-core/node_modules/
3232
./packages/zcli-apps/node_modules/
3333
./packages/zcli-themes/node_modules/
34+
./packages/zcli-connectors/node_modules/
3435
key: node-modules-${{ runner.os }}-${{ hashFiles('**/package.json') }}-${{ hashFiles('yarn.lock') }}
3536
restore-keys: |
3637
node-modules-${{ runner.os }}-${{ hashFiles('**/package.json') }}-

‎CHANGELOG.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,43 @@
33
All notable changes to this project will be documented in this file.
44
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
55

6+
# [1.0.0-beta.56](https://github.com/zendesk/zcli/compare/v1.0.0-beta.55...v1.0.0-beta.56) (2026-04-10)
7+
8+
9+
### Bug Fixes
10+
11+
* adding condition for spinner and exit 1 ([cb40a5c](https://github.com/zendesk/zcli/commit/cb40a5cd8cf2625f4cfe5b633ed0e114d3de3285))
12+
* adding tests for list command ([85973ff](https://github.com/zendesk/zcli/commit/85973ff8cac398371826c45b30438e5ee1bb2a6c))
13+
* addressing review comments for delete command ([811350d](https://github.com/zendesk/zcli/commit/811350de94c14560e1079040a378dd08a5811461))
14+
* apply suggestions from code review ([2051a88](https://github.com/zendesk/zcli/commit/2051a88ea0c63ca9636cc790f526fb3b635efafc))
15+
* connectors template scaffold to use versions of its dependencies in package.json and correctly valid typescript config for connectors ([7c925dc](https://github.com/zendesk/zcli/commit/7c925dcc1d7d0363f6aa6952ff1fd0404d4ddca7))
16+
* fixing failing test for list ([f036f8c](https://github.com/zendesk/zcli/commit/f036f8c91378e3246215334fce146fb63dbefd77))
17+
* fixing failing tests ([d121777](https://github.com/zendesk/zcli/commit/d121777494049abbb52a15d120f22ba5cf1580a4))
18+
* fixing json mode remainder ([d98ce2e](https://github.com/zendesk/zcli/commit/d98ce2e9283b27c45662ff8677af1f61a4262dbc))
19+
* lint and test fixes ([5443258](https://github.com/zendesk/zcli/commit/544325863555957832df47e8f897109e05c53b41))
20+
* missing dependencies when running connectors:bundle ([cab8c95](https://github.com/zendesk/zcli/commit/cab8c95948f6220a418ff9417f590d42c888719c))
21+
* modifying endpoint for list ([a48dec3](https://github.com/zendesk/zcli/commit/a48dec3a662510513d9d5b94e9db355822298ee1))
22+
* refactoring non 200 response case ([1e027c5](https://github.com/zendesk/zcli/commit/1e027c551c25595ba80088a7891e6cbe1dd281b1))
23+
* remove connector nice id column ([fa3f671](https://github.com/zendesk/zcli/commit/fa3f6715d3e5fdd834d58595b0b030d1f0cd05d0))
24+
* removing json flag for zcli ([b668f86](https://github.com/zendesk/zcli/commit/b668f86fee8eb3c2a6f8cf3c246a7da6b49aed6f))
25+
* removng localestriing conversion ([2561ff4](https://github.com/zendesk/zcli/commit/2561ff4a062034ea622ac7332adcf532f95bcd0c))
26+
* update response log based on review ([1f32669](https://github.com/zendesk/zcli/commit/1f326692e736b3e01a2c47b3afbbf89e1ad11710))
27+
28+
29+
### Features
30+
31+
* add connector starter template ([88014b7](https://github.com/zendesk/zcli/commit/88014b76be04f38e8e3b9a4fc4c4b8fded449db3))
32+
* adding list command to connectors zcli ([61a94c7](https://github.com/zendesk/zcli/commit/61a94c737fca4cc7531486bf628efa131f780d10))
33+
* adding zcli delete command ([6b37377](https://github.com/zendesk/zcli/commit/6b373775ac438ed30729cd9692954db7ef438d27))
34+
* **connectors:** include logo in starter template ([b8d8cd8](https://github.com/zendesk/zcli/commit/b8d8cd8e3032f67adb837c6f60a3e97a6d30f985))
35+
* implements create connector from copying the connector starter ([c3353e0](https://github.com/zendesk/zcli/commit/c3353e0747605385dfb6b2f13198daddf9f746f0))
36+
* init connector:create command no logic just plumbing ([3742875](https://github.com/zendesk/zcli/commit/3742875e7f3cb2e49386a957224ccb65f425ef39))
37+
* **VEG-3619:** Add connector bump command in zcli ([4b69c0c](https://github.com/zendesk/zcli/commit/4b69c0c467610bfca757e539f8f920a145a0f8a2))
38+
39+
40+
41+
42+
643
# [1.0.0-beta.55](https://github.com/zendesk/zcli/compare/v1.0.0-beta.54...v1.0.0-beta.55) (2026-02-04)
744

845

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ WSL2 now [supports running Linux GUI application](https://docs.microsoft.com/en-
6060
ZCLI supports numerous commands. Further documentation on available commands can be found [here.](/docs)
6161

6262
- [`$ zcli apps`](/docs/apps.md) - manage zendesk apps workflow.
63+
- [`$ zcli connectors`](/docs/connectors.md) - manage zendesk connectors workflow.
6364
- [`$ zcli themes`](/docs/themes.md) - manage zendesk themes workflow.
6465
- [`$ zcli profiles`](/docs/profiles.md) - manage zcli profiles.
6566
- [`$ zcli login`](/docs/login.md) - login to zendesk account.

‎docs/connectors.md‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
`zcli connectors`
2+
=================
3+
4+
The `zcli connectors` commands help manage Zendesk connector workflows.
5+
6+
* [`zcli connectors:bump [PATH]`](#zcli-connectorsbump-path)
7+
* [`zcli connectors:bundle [PATH]`](#zcli-connectorsbundle-path)
8+
* [`zcli connectors:create CONNECTOR`](#zcli-connectorscreate-connector)
9+
* [`zcli connectors:delete [CONNECTOR]`](#zcli-connectorsdelete-connector)
10+
* [`zcli connectors:list`](#zcli-connectorslist)
11+
* [`zcli connectors:publish [PATH]`](#zcli-connectorspublish-path)
12+
* [`zcli connectors:publish-status [PATH]`](#zcli-connectorspublish-status-path)
13+
14+
## `zcli connectors:bump [PATH]`
15+
16+
bumps the version of your connector
17+
18+
```
19+
USAGE
20+
$ zcli connectors:bump [PATH]
21+
22+
OPTIONS
23+
-M, --major increments the major version by 1
24+
-m, --minor increments the minor version by 1
25+
-p, --patch increments the patch version by 1
26+
-h, --help show CLI help
27+
28+
EXAMPLES
29+
$ zcli connectors:bump
30+
$ zcli connectors:bump ./my-connector
31+
$ zcli connectors:bump -M ./my-connector
32+
$ zcli connectors:bump -m ./my-connector
33+
$ zcli connectors:bump -p ./my-connector
34+
```
35+
36+
## `zcli connectors:bundle [PATH]`
37+
38+
bundles your connector for distribution
39+
40+
```
41+
USAGE
42+
$ zcli connectors:bundle [PATH]
43+
44+
OPTIONS
45+
-h, --help show CLI help
46+
-v, --verbose verbose output
47+
-w, --watch watch for file changes and automatically rebundle the connector
48+
49+
EXAMPLES
50+
$ zcli connectors:bundle
51+
$ zcli connectors:bundle ./example-connector
52+
$ zcli connectors:bundle --watch
53+
$ zcli connectors:bundle ./example-connector --watch
54+
```
55+
56+
## `zcli connectors:create CONNECTOR`
57+
58+
scaffolds a new connector project
59+
60+
```
61+
USAGE
62+
$ zcli connectors:create CONNECTOR
63+
64+
OPTIONS
65+
-h, --help show CLI help
66+
67+
ARGUMENTS
68+
CONNECTOR name of the connector
69+
70+
EXAMPLE
71+
$ zcli connectors:create connector-name
72+
```
73+
74+
## `zcli connectors:delete [CONNECTOR]`
75+
76+
delete a private connector from your account
77+
78+
```
79+
USAGE
80+
$ zcli connectors:delete [CONNECTOR]
81+
82+
ARGUMENTS
83+
CONNECTOR name of the connector to delete
84+
85+
OPTIONS
86+
-h, --help show CLI help
87+
-v, --verbose verbose output
88+
-f, --force skip confirmation prompt
89+
90+
EXAMPLES
91+
$ zcli connectors:delete my-connector
92+
$ zcli connectors:delete
93+
$ zcli connectors:delete my-connector --force
94+
```
95+
96+
## `zcli connectors:list`
97+
98+
list private connectors for the current account
99+
100+
```
101+
USAGE
102+
$ zcli connectors:list
103+
104+
OPTIONS
105+
-h, --help show CLI help
106+
-v, --verbose verbose output
107+
--json output in JSON format
108+
109+
EXAMPLES
110+
$ zcli connectors:list
111+
$ zcli connectors:list --json
112+
```
113+
114+
## `zcli connectors:publish [PATH]`
115+
116+
publish a connector to the current account
117+
118+
```
119+
USAGE
120+
$ zcli connectors:publish [PATH]
121+
122+
ARGUMENTS
123+
PATH path to connector directory
124+
125+
OPTIONS
126+
-h, --help show CLI help
127+
-v, --verbose verbose output
128+
--validationOnly validate the connector without publishing
129+
130+
EXAMPLES
131+
$ zcli connectors:publish ./example-connector
132+
$ zcli connectors:publish ./example-connector --validationOnly
133+
```
134+
135+
## `zcli connectors:publish-status [PATH]`
136+
137+
check the provisioning status of a connector
138+
139+
```
140+
USAGE
141+
$ zcli connectors:publish-status [PATH]
142+
143+
ARGUMENTS
144+
PATH path to connector directory
145+
146+
OPTIONS
147+
-h, --help show CLI help
148+
149+
EXAMPLES
150+
$ zcli connectors:publish-status
151+
$ zcli connectors:publish-status ./my-connector
152+
```

‎lerna.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@
2525
"--no-lockfile"
2626
],
2727
"useWorkspaces": true,
28-
"version": "1.0.0-beta.55"
28+
"version": "1.0.0-beta.56"
2929
}

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@
5151
"git:check": "./scripts/git_check.sh",
5252
"link:bin": "bash ./scripts/link_dev.sh",
5353
"lint": "eslint . --ext .ts --config .eslintrc",
54-
"test": "nyc --extension .ts mocha --config=.mocharc.json --forbid-only packages/**/src/**/*.test.ts",
55-
"test:functional": "mocha --config=.mocharc.json -r ts-node/register packages/**/tests/**/*.test.ts",
54+
"test": "nyc --extension .ts mocha --config=.mocharc.json --forbid-only 'packages/**/src/**/*.test.ts'",
55+
"test:functional": "mocha --config=.mocharc.json -r ts-node/register 'packages/**/tests/**/*.test.ts'",
5656
"changelog": "lerna-changelog",
5757
"type:check": "lerna run type:check"
5858
},

‎packages/zcli-connectors/CHANGELOG.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,43 @@
33
All notable changes to this project will be documented in this file.
44
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
55

6+
# [1.0.0-beta.56](https://github.com/zendesk/zcli/compare/v1.0.0-beta.55...v1.0.0-beta.56) (2026-04-10)
7+
8+
9+
### Bug Fixes
10+
11+
* adding condition for spinner and exit 1 ([cb40a5c](https://github.com/zendesk/zcli/commit/cb40a5cd8cf2625f4cfe5b633ed0e114d3de3285))
12+
* adding tests for list command ([85973ff](https://github.com/zendesk/zcli/commit/85973ff8cac398371826c45b30438e5ee1bb2a6c))
13+
* addressing review comments for delete command ([811350d](https://github.com/zendesk/zcli/commit/811350de94c14560e1079040a378dd08a5811461))
14+
* apply suggestions from code review ([2051a88](https://github.com/zendesk/zcli/commit/2051a88ea0c63ca9636cc790f526fb3b635efafc))
15+
* connectors template scaffold to use versions of its dependencies in package.json and correctly valid typescript config for connectors ([7c925dc](https://github.com/zendesk/zcli/commit/7c925dcc1d7d0363f6aa6952ff1fd0404d4ddca7))
16+
* fixing failing test for list ([f036f8c](https://github.com/zendesk/zcli/commit/f036f8c91378e3246215334fce146fb63dbefd77))
17+
* fixing failing tests ([d121777](https://github.com/zendesk/zcli/commit/d121777494049abbb52a15d120f22ba5cf1580a4))
18+
* fixing json mode remainder ([d98ce2e](https://github.com/zendesk/zcli/commit/d98ce2e9283b27c45662ff8677af1f61a4262dbc))
19+
* lint and test fixes ([5443258](https://github.com/zendesk/zcli/commit/544325863555957832df47e8f897109e05c53b41))
20+
* missing dependencies when running connectors:bundle ([cab8c95](https://github.com/zendesk/zcli/commit/cab8c95948f6220a418ff9417f590d42c888719c))
21+
* modifying endpoint for list ([a48dec3](https://github.com/zendesk/zcli/commit/a48dec3a662510513d9d5b94e9db355822298ee1))
22+
* refactoring non 200 response case ([1e027c5](https://github.com/zendesk/zcli/commit/1e027c551c25595ba80088a7891e6cbe1dd281b1))
23+
* remove connector nice id column ([fa3f671](https://github.com/zendesk/zcli/commit/fa3f6715d3e5fdd834d58595b0b030d1f0cd05d0))
24+
* removing json flag for zcli ([b668f86](https://github.com/zendesk/zcli/commit/b668f86fee8eb3c2a6f8cf3c246a7da6b49aed6f))
25+
* removng localestriing conversion ([2561ff4](https://github.com/zendesk/zcli/commit/2561ff4a062034ea622ac7332adcf532f95bcd0c))
26+
* update response log based on review ([1f32669](https://github.com/zendesk/zcli/commit/1f326692e736b3e01a2c47b3afbbf89e1ad11710))
27+
28+
29+
### Features
30+
31+
* add connector starter template ([88014b7](https://github.com/zendesk/zcli/commit/88014b76be04f38e8e3b9a4fc4c4b8fded449db3))
32+
* adding list command to connectors zcli ([61a94c7](https://github.com/zendesk/zcli/commit/61a94c737fca4cc7531486bf628efa131f780d10))
33+
* adding zcli delete command ([6b37377](https://github.com/zendesk/zcli/commit/6b373775ac438ed30729cd9692954db7ef438d27))
34+
* **connectors:** include logo in starter template ([b8d8cd8](https://github.com/zendesk/zcli/commit/b8d8cd8e3032f67adb837c6f60a3e97a6d30f985))
35+
* implements create connector from copying the connector starter ([c3353e0](https://github.com/zendesk/zcli/commit/c3353e0747605385dfb6b2f13198daddf9f746f0))
36+
* init connector:create command no logic just plumbing ([3742875](https://github.com/zendesk/zcli/commit/3742875e7f3cb2e49386a957224ccb65f425ef39))
37+
* **VEG-3619:** Add connector bump command in zcli ([4b69c0c](https://github.com/zendesk/zcli/commit/4b69c0c467610bfca757e539f8f920a145a0f8a2))
38+
39+
40+
41+
42+
643
# [1.0.0-beta.55](https://github.com/zendesk/zcli/compare/v1.0.0-beta.54...v1.0.0-beta.55) (2026-02-04)
744

845

‎packages/zcli-connectors/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@zendesk/zcli-connectors",
33
"description": "zcli connectors commands live here",
4-
"version": "1.0.0-beta.55",
4+
"version": "1.0.0-beta.56",
55
"author": "@vegemite",
66
"npmRegistry": "https://registry.npmjs.org",
77
"publishConfig": {

‎packages/zcli-connectors/src/commands/connectors/bump.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import { existsSync, readFileSync, writeFileSync } from 'fs'
55
import { join, resolve } from 'path'
66

77
export default class Bump extends Command {
8-
static description = 'bumps the version of your connector in the manifest. Accepts major, minor and patch; defaults to patch.'
8+
static description = 'bumps the version of your connector'
99

1010
static args = [
11-
{ name: 'path', description: 'relative path to connector root directory (optional, defaults to current directory)' }
11+
{ name: 'path', description: 'path to connector directory (defaults to current directory)', default: '.' }
1212
]
1313

1414
static examples = [
@@ -21,9 +21,9 @@ export default class Bump extends Command {
2121

2222
static flags = {
2323
help: Flags.help({ char: 'h' }),
24-
major: Flags.boolean({ char: 'M', description: 'Increments the major version by 1' }),
25-
minor: Flags.boolean({ char: 'm', description: 'Increments the minor version by 1' }),
26-
patch: Flags.boolean({ char: 'p', description: 'Increments the patch version by 1' })
24+
major: Flags.boolean({ char: 'M', description: 'increments the major version by 1' }),
25+
minor: Flags.boolean({ char: 'm', description: 'increments the minor version by 1' }),
26+
patch: Flags.boolean({ char: 'p', description: 'increments the patch version by 1' })
2727
}
2828

2929
async run (): Promise<void> {

‎packages/zcli-connectors/src/commands/connectors/bundle.ts‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ import { ViteConfigBuilder, ViteRunner } from '../../lib/vite'
77
import * as ora from 'ora'
88

99
export default class Bundle extends Command {
10+
static description = 'bundles your connector for distribution'
11+
1012
static examples = [
1113
'<%= config.bin %> <%= command.id %>',
12-
'<%= config.bin %> <%= command.id %> ./example-connector'
14+
'<%= config.bin %> <%= command.id %> ./example-connector',
15+
'<%= config.bin %> <%= command.id %> --watch',
16+
'<%= config.bin %> <%= command.id %> ./example-connector --watch'
1317
]
1418

1519
static flags = {
@@ -21,15 +25,16 @@ export default class Bundle extends Command {
2125
}),
2226
watch: Flags.boolean({
2327
char: 'w',
24-
description: 'watch for changes and rebuild',
28+
description: 'watch for file changes and automatically rebundle the connector',
2529
default: false
2630
})
2731
}
2832

2933
static args = [
3034
{
3135
name: 'path',
32-
description: 'relative path to connector root directory (optional, defaults to current directory)'
36+
description: 'path to connector directory (defaults to current directory)',
37+
default: '.'
3338
}
3439
]
3540

0 commit comments

Comments
 (0)