Skip to content

Commit

Permalink
docs: fix npx usage
Browse files Browse the repository at this point in the history
Since we recommend Node v14 in our docs, it ships with npx@6 which experiences weirdness with the `-y` option. Since it's being run in a CI environment, the `-y` option shouldn't be required anyways.
  • Loading branch information
kanadgupta committed Aug 19, 2022
1 parent 8714967 commit 3c9f4bf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions documentation/rdme.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ To use a GitHub secret in your `rdme` GitHub Action, first [create a new reposit

## Usage in Other CI Environments

Since `rdme` is a command-line tool at its core, you can use `rdme` to sync your documentation from virtually any CI/CD environment that runs shell commands—[Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/), [GitLab CI/CD](https://docs.gitlab.com/ee/ci/), you name it! You can do this by invoking `rdme` with `npx -y rdme@RDME_VERSION` in a Node.js environment. See below for several examples.
Since `rdme` is a command-line tool at its core, you can use `rdme` to sync your documentation from virtually any CI/CD environment that runs shell commands—[Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/), [GitLab CI/CD](https://docs.gitlab.com/ee/ci/), you name it! You can do this by invoking `rdme` with `npx rdme@RDME_VERSION` in a Node.js environment. See below for several examples.

<!--
The two code blocks below must be joined (i.e. no newline in between) in order to render as tabbed code blocks in ReadMe.
Expand All @@ -270,7 +270,7 @@ pipelines:
default:
- step:
script:
- npx -y rdme@RDME_VERSION openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
- npx rdme@RDME_VERSION openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
```
```yml GitLab CI (rdme-sync.gitlab-ci.yml)
# Official framework image. Look for the different tagged releases at:
Expand All @@ -279,7 +279,7 @@ image: node:NODE_VERSION
sync-via-rdme:
script:
- npx -y rdme@RDME_VERSION openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
- npx rdme@RDME_VERSION openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
```
<!-- prettier-ignore-end -->

Expand Down

0 comments on commit 3c9f4bf

Please sign in to comment.