Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump peridio cli docs to 0.23.0 #212

Merged
merged 2 commits into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/build-and-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
## Build

```
npm --prefix src build
npm --prefix src run build
```

Builds and outputs static content into the `build` directory ready to be served.

## Generate Peridio CLI Docs

```
npm --prefix src gen-cli
npm --prefix src run gen-cli
```

This command uses your local Peridio CLI. The script itself hardcodes a particular version requirement of the CLI to help protect against documentation regression.
Expand Down
2 changes: 2 additions & 0 deletions src/docs/cli/ca-certificates/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Options:
An arbitrary string attached to the jitp resource. Often useful for displaying to users
--jitp-tags [<JITP_TAGS>...]
Tags that will be automatically applied to devices that JITP with this CA certificate
--jitp-target <JITP_TARGET>
The target that will be automatically applied to devices that JITP with this CA certificate
--jitp-product-name <JITP_PRODUCT_NAME>
The product that will be automatically applied to devices that JITP with this CA certificate
--jitp-cohort-prn <JITP_COHORT_PRN>
Expand Down
2 changes: 2 additions & 0 deletions src/docs/cli/ca-certificates/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Options:
An arbitrary string attached to the jitp resource. Often useful for displaying to users
--jitp-tags [<JITP_TAGS>...]
Tags that will be automatically applied to devices that JITP with this CA certificate
--jitp-target <JITP_TARGET>
The target that will be automatically applied to devices that JITP with this CA certificate
--jitp-product-name <JITP_PRODUCT_NAME>
The product that will be automatically applied to devices that JITP with this CA certificate
--jitp-cohort-prn <JITP_COHORT_PRN>
Expand Down
1 change: 1 addition & 0 deletions src/docs/cli/tunnels/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Usage: peridio tunnels update [OPTIONS] --prn <PRN>
Options:
--prn <PRN> The PRN of the resource to update
--state <STATE> The resource's state, currently only supports "closed"
--ttl <TTL> Number of seconds to extend the tunnel for (1..3600)
-h, --help Print help

```
8 changes: 4 additions & 4 deletions src/scripts/gen-cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ function processCommandHelp(cmd) {
})
}

exec('peridio --version', (_error, stdout) => {
const requiredVersion = 'peridio 0.22.0 56a27bc'
exec('peridio upgrade', (_error, stdout) => {
const latest = 'CLI already up to date'

if (stdout.includes(requiredVersion)) {
if (stdout.includes(latest)) {
processCommandHelp([])
} else {
console.error(
`Your local Peridio CLI has version (${stdout.trim()}) but this script requires version (${requiredVersion})`,
'You must update your Peridio CLI before generating docs',
)
}
})