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

docs(legacy): add clarity around readme-oas-key #464

Merged
merged 1 commit into from
Mar 2, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions documentation/legacy-github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If you previously had a GitHub Workflow file set up that used this action to syn
api-version: 'v1.0.0'
```

where `API_KEY` was your project API key and the `API_DEFINITION_ID` was your API definition ID in the dashboard.
where the `readme-oas-key` was a concatenation of the `API_KEY` (your project API key) and the `API_DEFINITION_ID` (your API definition ID), separated by a colon.

For migrating to [the `rdme`-based GitHub Action](https://docs.readme.com/docs/rdme), simply modify the step to look like this:

Expand All @@ -41,10 +41,11 @@ For migrating to [the `rdme`-based GitHub Action](https://docs.readme.com/docs/r
rdme: openapi path/to/file.json --key=API_KEY --id=API_DEFINITION_ID
```

There are two things to note:
There are a few things to note:

1. This workflow will infer the `api-version` based on the `API_DEFINITION_ID` parameter that you pass in, so the API version parameter is no longer needed here.
2. `@RDME_VERSION` is the latest version of `rdme`. To ensure you're getting the latest features and security updates, we strongly recommend setting up [Dependabot](https://docs.github.com/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot) to keep this package up-to-date.
3. If you used secrets to encrypt the `readme-oas-key` value, you'll have to split this value out into two separate secrets—one for the API key and one for the API definition ID. You can see an example of this [here](https://docs.readme.com/docs/rdme#example-using-github-secrets).

<details>

Expand Down
2 changes: 1 addition & 1 deletion documentation/rdme.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ To use a GitHub secret in your `rdme` GitHub Action, first [create a new reposit
```yml
- uses: readmeio/rdme@RDME_VERSION
with:
rdme: docs ./documentation --key=${{ secrets.README_API_KEY }} --version=2.0
rdme: openapi [path-to-file.json] --key={{ secrets.README_API_KEY }} --id={{ secrets.README_API_DEFINITION_ID }}
```

## Usage in Other CI Environments
Expand Down