Skip to content

Commit f08f0fc

Browse files
authored
Merge branch 'master' into fix/pipeline
2 parents 48007ca + b71483a commit f08f0fc

File tree

4 files changed

+126
-78
lines changed

4 files changed

+126
-78
lines changed

README.md

Lines changed: 121 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -28,116 +28,115 @@ oclif example Hello World CLI
2828
# Usage
2929
<!-- usage -->
3030
```sh-session
31-
$ npm install -g oclif-hello-world
32-
$ oex COMMAND
31+
$ npm install -g github-automation
32+
$ github-automation COMMAND
3333
running command...
34-
$ oex (--version)
35-
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
36-
$ oex --help [COMMAND]
34+
$ github-automation (--version)
35+
github-automation/3.2.7 linux-x64 node-v16.20.0
36+
$ github-automation --help [COMMAND]
3737
USAGE
38-
$ oex COMMAND
38+
$ github-automation COMMAND
3939
...
4040
```
4141
<!-- usagestop -->
4242
# Commands
4343
<!-- commands -->
44-
* [`oex hello PERSON`](#oex-hello-person)
45-
* [`oex hello world`](#oex-hello-world)
46-
* [`oex help [COMMAND]`](#oex-help-command)
47-
* [`oex plugins`](#oex-plugins)
48-
* [`oex plugins:inspect PLUGIN...`](#oex-pluginsinspect-plugin)
49-
* [`oex plugins:install PLUGIN...`](#oex-pluginsinstall-plugin)
50-
* [`oex plugins:link PLUGIN`](#oex-pluginslink-plugin)
51-
* [`oex plugins:uninstall PLUGIN...`](#oex-pluginsuninstall-plugin)
52-
* [`oex plugins update`](#oex-plugins-update)
44+
* [`github-automation help [COMMANDS]`](#github-automation-help-commands)
45+
* [`github-automation plugins`](#github-automation-plugins)
46+
* [`github-automation plugins:install PLUGIN...`](#github-automation-pluginsinstall-plugin)
47+
* [`github-automation plugins:inspect PLUGIN...`](#github-automation-pluginsinspect-plugin)
48+
* [`github-automation plugins:install PLUGIN...`](#github-automation-pluginsinstall-plugin-1)
49+
* [`github-automation plugins:link PLUGIN`](#github-automation-pluginslink-plugin)
50+
* [`github-automation plugins:uninstall PLUGIN...`](#github-automation-pluginsuninstall-plugin)
51+
* [`github-automation plugins:uninstall PLUGIN...`](#github-automation-pluginsuninstall-plugin-1)
52+
* [`github-automation plugins:uninstall PLUGIN...`](#github-automation-pluginsuninstall-plugin-2)
53+
* [`github-automation plugins update`](#github-automation-plugins-update)
5354

54-
## `oex hello PERSON`
55+
## `github-automation help [COMMANDS]`
5556

56-
Say hello
57+
Display help for github-automation.
5758

5859
```
5960
USAGE
60-
$ oex hello [PERSON] -f <value>
61+
$ github-automation help [COMMANDS] [-n]
6162
6263
ARGUMENTS
63-
PERSON Person to say hello to
64+
COMMANDS Command to show help for.
6465
6566
FLAGS
66-
-f, --from=<value> (required) Who is saying hello
67+
-n, --nested-commands Include all nested commands in the output.
6768
6869
DESCRIPTION
69-
Say hello
70-
71-
EXAMPLES
72-
$ oex hello friend --from oclif
73-
hello friend from oclif! (./src/commands/hello/index.ts)
70+
Display help for github-automation.
7471
```
7572

76-
_See code: [dist/commands/hello/index.ts](https://github.com/oclif/hello-world/blob/v0.0.0/dist/commands/hello/index.ts)_
73+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
7774

78-
## `oex hello world`
75+
## `github-automation plugins`
7976

80-
Say hello world
77+
List installed plugins.
8178

8279
```
8380
USAGE
84-
$ oex hello world
81+
$ github-automation plugins [--core]
82+
83+
FLAGS
84+
--core Show core plugins.
8585
8686
DESCRIPTION
87-
Say hello world
87+
List installed plugins.
8888
8989
EXAMPLES
90-
$ oex hello world
91-
hello world! (./src/commands/hello/world.ts)
90+
$ github-automation plugins
9291
```
9392

94-
## `oex help [COMMAND]`
93+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
9594

96-
Display help for oex.
95+
## `github-automation plugins:install PLUGIN...`
96+
97+
Installs a plugin into the CLI.
9798

9899
```
99100
USAGE
100-
$ oex help [COMMAND] [-n]
101+
$ github-automation plugins:install PLUGIN...
101102
102103
ARGUMENTS
103-
COMMAND Command to show help for.
104+
PLUGIN Plugin to install.
104105
105106
FLAGS
106-
-n, --nested-commands Include all nested commands in the output.
107+
-f, --force Run yarn install with force flag.
108+
-h, --help Show CLI help.
109+
-v, --verbose
107110
108111
DESCRIPTION
109-
Display help for oex.
110-
```
112+
Installs a plugin into the CLI.
113+
Can be installed from npm or a git url.
111114
112-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
115+
Installation of a user-installed plugin will override a core plugin.
113116
114-
## `oex plugins`
117+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
118+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
119+
the CLI without the need to patch and update the whole CLI.
115120
116-
List installed plugins.
117121
118-
```
119-
USAGE
120-
$ oex plugins [--core]
122+
ALIASES
123+
$ github-automation plugins add
121124
122-
FLAGS
123-
--core Show core plugins.
125+
EXAMPLES
126+
$ github-automation plugins:install myplugin
124127
125-
DESCRIPTION
126-
List installed plugins.
128+
$ github-automation plugins:install https://github.com/someuser/someplugin
127129
128-
EXAMPLES
129-
$ oex plugins
130+
$ github-automation plugins:install someuser/someplugin
130131
```
131132

132-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
133-
134-
## `oex plugins:inspect PLUGIN...`
133+
## `github-automation plugins:inspect PLUGIN...`
135134

136135
Displays installation properties of a plugin.
137136

138137
```
139138
USAGE
140-
$ oex plugins:inspect PLUGIN...
139+
$ github-automation plugins:inspect PLUGIN...
141140
142141
ARGUMENTS
143142
PLUGIN [default: .] Plugin to inspect.
@@ -146,20 +145,23 @@ FLAGS
146145
-h, --help Show CLI help.
147146
-v, --verbose
148147
148+
GLOBAL FLAGS
149+
--json Format output as json.
150+
149151
DESCRIPTION
150152
Displays installation properties of a plugin.
151153
152154
EXAMPLES
153-
$ oex plugins:inspect myplugin
155+
$ github-automation plugins:inspect myplugin
154156
```
155157

156-
## `oex plugins:install PLUGIN...`
158+
## `github-automation plugins:install PLUGIN...`
157159

158160
Installs a plugin into the CLI.
159161

160162
```
161163
USAGE
162-
$ oex plugins:install PLUGIN...
164+
$ github-automation plugins:install PLUGIN...
163165
164166
ARGUMENTS
165167
PLUGIN Plugin to install.
@@ -171,7 +173,6 @@ FLAGS
171173
172174
DESCRIPTION
173175
Installs a plugin into the CLI.
174-
175176
Can be installed from npm or a git url.
176177
177178
Installation of a user-installed plugin will override a core plugin.
@@ -180,24 +181,25 @@ DESCRIPTION
180181
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
181182
the CLI without the need to patch and update the whole CLI.
182183
184+
183185
ALIASES
184-
$ oex plugins add
186+
$ github-automation plugins add
185187
186188
EXAMPLES
187-
$ oex plugins:install myplugin
189+
$ github-automation plugins:install myplugin
188190
189-
$ oex plugins:install https://github.com/someuser/someplugin
191+
$ github-automation plugins:install https://github.com/someuser/someplugin
190192
191-
$ oex plugins:install someuser/someplugin
193+
$ github-automation plugins:install someuser/someplugin
192194
```
193195

194-
## `oex plugins:link PLUGIN`
196+
## `github-automation plugins:link PLUGIN`
195197

196198
Links a plugin into the CLI for development.
197199

198200
```
199201
USAGE
200-
$ oex plugins:link PLUGIN
202+
$ github-automation plugins:link PLUGIN
201203
202204
ARGUMENTS
203205
PATH [default: .] path to plugin
@@ -208,23 +210,69 @@ FLAGS
208210
209211
DESCRIPTION
210212
Links a plugin into the CLI for development.
211-
212213
Installation of a linked plugin will override a user-installed or core plugin.
213214
214215
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
215216
command will override the user-installed or core plugin implementation. This is useful for development work.
216217
218+
217219
EXAMPLES
218-
$ oex plugins:link myplugin
220+
$ github-automation plugins:link myplugin
221+
```
222+
223+
## `github-automation plugins:uninstall PLUGIN...`
224+
225+
Removes a plugin from the CLI.
226+
227+
```
228+
USAGE
229+
$ github-automation plugins:uninstall PLUGIN...
230+
231+
ARGUMENTS
232+
PLUGIN plugin to uninstall
233+
234+
FLAGS
235+
-h, --help Show CLI help.
236+
-v, --verbose
237+
238+
DESCRIPTION
239+
Removes a plugin from the CLI.
240+
241+
ALIASES
242+
$ github-automation plugins unlink
243+
$ github-automation plugins remove
244+
```
245+
246+
## `github-automation plugins:uninstall PLUGIN...`
247+
248+
Removes a plugin from the CLI.
249+
250+
```
251+
USAGE
252+
$ github-automation plugins:uninstall PLUGIN...
253+
254+
ARGUMENTS
255+
PLUGIN plugin to uninstall
256+
257+
FLAGS
258+
-h, --help Show CLI help.
259+
-v, --verbose
260+
261+
DESCRIPTION
262+
Removes a plugin from the CLI.
263+
264+
ALIASES
265+
$ github-automation plugins unlink
266+
$ github-automation plugins remove
219267
```
220268

221-
## `oex plugins:uninstall PLUGIN...`
269+
## `github-automation plugins:uninstall PLUGIN...`
222270

223271
Removes a plugin from the CLI.
224272

225273
```
226274
USAGE
227-
$ oex plugins:uninstall PLUGIN...
275+
$ github-automation plugins:uninstall PLUGIN...
228276
229277
ARGUMENTS
230278
PLUGIN plugin to uninstall
@@ -237,17 +285,17 @@ DESCRIPTION
237285
Removes a plugin from the CLI.
238286
239287
ALIASES
240-
$ oex plugins unlink
241-
$ oex plugins remove
288+
$ github-automation plugins unlink
289+
$ github-automation plugins remove
242290
```
243291

244-
## `oex plugins update`
292+
## `github-automation plugins update`
245293

246294
Update installed plugins.
247295

248296
```
249297
USAGE
250-
$ oex plugins update [-h] [-v]
298+
$ github-automation plugins update [-h] [-v]
251299
252300
FLAGS
253301
-h, --help Show CLI help.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-automation",
3-
"version": "0.0.0",
3+
"version": "3.2.7",
44
"description": "oclif example Hello World CLI",
55
"author": "Jorge Saud @Giorgiosaud",
66
"bin": {

tsconfig.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
"outDir": "dist",
88
"rootDir": "src",
99
"strict": true,
10-
"target": "es2019",
11-
"skipLibCheck": true
10+
"skipLibCheck": true,
11+
"target": "es2019"
1212

1313
},
1414
"include": [

0 commit comments

Comments
 (0)