8.4.0

This release adds an openapi:convert command, documentation on our new 1Password shell plugin, and more. See below for the highlights:

• #715 adds the ability to pass in a GitHub blob link to an API definition into the openapi family of commands, and it will automatically be converted to a raw URL prior to fetching the file. See below for an example:

rdme openapi https://github.com/readmeio/oas-examples/blob/main/3.0/json/petstore.json

• #717 adds a new command called openapi:convert for converting Swagger 2.0 definitions and Postman Collections into OpenAPI.
• #718 adds a new flag to the openapi and openapi:reduce commands called title, which overrides the info.title field in your OpenAPI definition (which is used for setting the category title in ReadMe).
• #720 adds documentation for our new 1Password shell plugin, which allows you to store your ReadMe API key in 1Password and securely pass it in your rdme commands using biometrics (supported in [email protected] and above). See below for a demo of this behavior:

readme-1p.mp4

What's Changed

• fix: login issue when user doesn't pass in API key by @kanadgupta in #714
• chore: bump deps by @kanadgupta in #715
• feat(openapi): exposing our spec conversion tooling to a new :convert command by @erunion in #717
• feat(openapi): add ability to override title by @kanadgupta in #718
• docs: 1password shell plugin by @kanadgupta in #720
• feat(api): surface Warning response headers by @kanadgupta in #721

Full Changelog: v8.3.1...8.4.0

8.3.1

This release adds the ability to pass flags into login and resolves a bug with docs:prune.

What's Changed

• feat(login): opts by @kanadgupta in #712
• fix(docs:prune): prune child docs by @kanadgupta in #713

Full Changelog: v8.3.0...8.3.1

8.3.0

This release introduces a new command called openapi:inspect, which provides various insights on how your API definition is utilizing the OpenAPI Specification.

This release also includes support for passing in your API key via the environmental variable RDME_API_KEY. More information can be found in the Authentication section.

What's Changed

• feat(openapi): introduction of a new openapi:inspect command by @erunion in #698
• chore(deps-dev): bumping dev deps and resolving type -> interface conversions by @erunion in #708
• feat: dropping our position system for ordering commands in --help by @erunion in #707
• feat: ability to pass in API key via env vars by @kanadgupta in #709

Full Changelog: v8.2.1...8.3.0

8.2.1

This release fixes an issue where git remote connection errors weren't being handled properly and folks were seeing errors like this:

fatal: unable to access 'https://badremoteurl.git/': Could not resolve host: badremoteurl.git

This release also adds the ability to pass CLI arguments into the openapi:reduce command, as well as some minor documentation and dependency updates.

What's Changed

• feat(openapi:reduce): pass opts by @kanadgupta in #684
• chore(deps): bump a bunch of deps by @kanadgupta in #695
• ci: caching deps in ci by @erunion in #696
• docs: better callout for rdme login usage by @kanadgupta in #699
• test: cleaning up our jest config by @erunion in #700
• fix(createGHA): git remote connection errors by @kanadgupta in #705

Full Changelog: v8.2.0...8.2.1

8.2.0

We've added a new version tag (v8) to simplify access to the latest version of rdme in your GitHub Actions workflows. This release also adds support for proxies.

Major Version Tags 🏷️

You can now point your GitHub Actions rdme references to the v8 tag, which will automatically update with every future release that's part of the current major version¹. This will help ensure that your GitHub Actions workflow is using the latest and greatest version of rdme, while ensuring that your workflow doesn't break for future major releases.

This is similar to how you can reference the latest v3 release of actions/checkout Action using actions/checkout@v3. See below for an example:

- uses: actions/checkout@v3
- uses: readmeio/rdme@v8
  with:
    rdme: [your command here]

What's Changed

• fix: unreachable code and those not getting flagged by eslint by @erunion in #677
• docs: update version/category to reflect new location by @kanadgupta in #678
• feat: proxy support by @kanadgupta in #681
• feat: major version tags by @kanadgupta in #682

Full Changelog: v8.1.1...8.2.0

1. We use SemVer conventions for versioning rdme. ↩

8.1.1

What's Changed

• ci: remove retag-release workflow by @kanadgupta in #674
• feat(open): rdme open should have a flag for opening the dash by @darrenyong in #671
• fix: don't prompt for version if only one exists by @kanadgupta in #675

Full Changelog: v8.1.0...8.1.1

8.1.0

This release ships support for Postman Collections in the openapi family of commands. Postman Collections are converted to OpenAPI using postman-to-openapi prior to any syncing/validation/reduction.

This release also includes a few fixes to prevent false positives with GitHub Actions onboarding.

What's Changed

• fix: package.json keywords declarations by @erunion in #666
• feat: adding support for uploading and validating Postman collections by @erunion in #669
• fix(createGHA): remove non-github remote check by @kanadgupta in #665
• fix: upgrade oas-normalize to fix a postman conversion issue by @erunion in #672
• fix: swap out @npmcli/ci-detect for ci-info by @kanadgupta in #667
• feat: postman-related enhancements, output cleanup by @kanadgupta in #673

Full Changelog: v8.0.4...8.1.0

8.0.4

This release fixes an issue with TypeScript-enabled repositories where running tsc with rdme@8 in the dependency tree may yield an error like this:

error TS2688: Cannot find type definition file for 'keyv'.
  The file is in the program because:
    Entry point for implicit type library 'keyv'

8.0.2

This release makes a small fix to our GitHub Actions onboarding questionnaire so it won't run if you're running rdme within an npm or yarn script.

What's Changed

• fix: npm script awareness, TS fixes, test env refactors by @kanadgupta in #659

Full Changelog: v8.0.1...8.0.2

8.0.1

This release includes a small fix to the GitHub Actions onboarding workflow to prevent the tool from running git commands in CI environments.

What's Changed

• chore(deps): bump @npmcli/ci-detect from 3.0.0 to 3.0.1 by @dependabot in #654
• chore(deps-dev): bump @readme/oas-examples from 5.7.0 to 5.8.0 by @dependabot in #656
• chore(deps): bump a bunch of deps by @kanadgupta in #658
• fix(gha-onboarding): don't run git commands in CI by @kanadgupta in #657

Full Changelog: v8.0.0...8.0.1