Skip to content

Commit 3e22db5

Browse files
authoredNov 18, 2020
Merge pull request #1527 from snyk/feat/command-docs
New --help command docs
2 parents 282a533 + 789af6b commit 3e22db5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+868
-406
lines changed
 

‎.circleci/config.yml

+15-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ commands:
7878
install_sbt_unix:
7979
description: Install SBT
8080
steps:
81-
- run:
81+
- run:
8282
name: Installing sbt
8383
command: sdk install sbt 1.3.12
8484
install_node_npm:
@@ -109,6 +109,12 @@ commands:
109109
- run:
110110
name: NPM version
111111
command: npm --version
112+
generate_help:
113+
description: Generate CLI help files
114+
steps:
115+
- run:
116+
name: Run CLI help text builder
117+
command: npm run generate-help
112118

113119
jobs:
114120
regression-test:
@@ -117,9 +123,13 @@ jobs:
117123
- image: circleci/node:<< parameters.node_version >>
118124
steps:
119125
- checkout
126+
- setup_remote_docker:
127+
version: 19.03.13
128+
# docker_layer_caching: true
120129
- install_shellspec
121130
- install_deps
122131
- build_ts
132+
- generate_help
123133
- run:
124134
name: Run auth
125135
command: npm run snyk-auth
@@ -213,7 +223,11 @@ jobs:
213223
resource_class: small
214224
steps:
215225
- checkout
226+
- setup_remote_docker:
227+
version: 19.03.13
228+
# docker_layer_caching: true
216229
- install_deps
230+
- generate_help
217231
- run: sudo npm i -g semantic-release @semantic-release/exec pkg
218232
- run: sudo apt-get install -y osslsigncode
219233
- run:

‎.github/CODEOWNERS

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Snyk Boost will be required for a review on every PR
22
README.md @snyk/content @snyk/boost
33
src/cli/commands/test/formatters/format-reachability.ts @snyk/flow
4-
help/ @snyk/content @snyk/boost
4+
help/ @snyk/hammer
55
* @snyk/hammer @snyk/boost
6-
help/iac.txt @snyk/cloudconfig
76
src/cli/commands/test/iac-output.ts @snyk/cloudconfig
87
src/lib/cloud-config-projects.ts @snyk/cloudconfig
98
src/lib/iac/ @snyk/cloudconfig
@@ -15,3 +14,5 @@ test/fixtures/iac/ @snyk/cloudconfig
1514
test/smoke/spec/iac/ @snyk/cloudconfig
1615
src/lib/errors/invalid-iac-file.ts @snyk/cloudconfig
1716
src/lib/errors/unsupported-options-iac-error.ts @snyk/cloudconfig
17+
help/commands-docs/iac-examples.md @snyk/cloudconfig
18+
help/commands-docs/iac.md @snyk/cloudconfig

0 commit comments

Comments
 (0)
Please sign in to comment.