8.6.2: npm package provenance, reducer fixes 🔐

In this release, we fixed a bug where openapi:reduce would fail to reduce certain files (#802, readmeio/oas#753).

And starting with this release, every release of rdme in the npm registry now includes:

• An npm-shrinkwrap.json file, which ensures that rdme installs with the correct dependency tree 🌲
• A provenance statement, which provides additional transparency around our build process¹ ✨

Neither of these will result in any actual changes to your experience with rdme — merely a few behind-the-scenes updates to ensure your installation through npm is stable and secure 🔐

What's Changed

• ci: add node 20 tests by @kanadgupta in #800
• fix(deps): bump oas (and others) by @kanadgupta in
• fix(npm): use shrinkwrap instead of lockfile by @kanadgupta in #803

Full Changelog: 8.6.1...8.6.2

1. You can find our provenance statement here: https://www.npmjs.com/package/rdme#provenance ↩

8.6.1: Bug Fixes for GitHub Actions Users 🗞️

This release fixes an issue (#787) where the rdme GitHub Action was unable to properly parse certain command arguments (e.g., filenames with quotation marks).

What's Changed

• ci: fix major version tagging process by @kanadgupta in #786
• chore(deps): bump by @kanadgupta in #795
• chore: remove outdated oas language, testbed cleanup 🧹 by @kanadgupta in #796
• fix(docker): safer argument parsing for GitHub Actions by @kanadgupta in #788
• chore(deps): bump by @kanadgupta in #797

Full Changelog: 8.6.0...8.6.1

8.6.0: ~5x faster GitHub Actions performance 🚀

Starting with this release, we include a corresponding pre-built Docker image hosted on the GitHub Container Registry. What does this mean for you? Much faster execution times when running the rdme GitHub Action — around 5x faster in most cases 🚀

Duplicating less build work = faster workflow execution times = lower billed usage for you and your loved ones 📉 see below for a few examples:

Command	Before1	After1
Validating an OpenAPI definition with rdme openapi:validate	18.2s	4.3s
Syncing an OpenAPI definition with rdme openapi	25.6s	8.4s
Syncing two Markdown files with rdme docs	20.5s	3.8s
Syncing seven Markdown files with rdme docs	21.7s	5.3s

We also made some improvements to our API definition parser to better handle the processing of larger and more complex files, as well as a few fixes for folks with Postman collections and definitions written in YAML.

What's Changed

• feat: docker (again) by @kanadgupta in #763
• fix: upgrading oas-normalize to move to our postman-to-openapi fork by @erunion in #776
• perf(docker): build executable by @kanadgupta in #764
• fix(openapi): yaml strings would be improperly parsed as Date objects by @erunion in #779
• feat: container registry by @kanadgupta in #777
• feat: add GHA output with command result by @kanadgupta in #781
• fix(openapi): memory leak in large file handling within oas-normalize by @erunion in #784

Full Changelog: 8.5.0...8.6.0

1. These numbers are the average of 10 actual workflow runs using the rdme GitHub Action on standard GitHub Actions Ubuntu runners. Your actual workflow times will vary! ↩ ↩²

8.6.0-next.17

What's Changed

• chore(deps): bump by @kanadgupta in #782
• feat: add GHA output with command result by @kanadgupta in #781
• fix(openapi): memory leak in large file handling within oas-normalize by @erunion in #784

Full Changelog: v8.6.0-next.16...8.6.0-next.17

8.6.0-next.14

What's Changed

• fix(openapi): yaml strings would be improperly parsed as Date objects by @erunion in #779

Full Changelog: v8.6.0-next.13...8.6.0-next.14

8.5.0

The biggest update in this release is that Markdown docs that don't contain front matter will now automatically be skipped as opposed to erroring out (see #729). This release also contains various little fixes and dependency updates.

Also with this release: we officially crossed 1000 commits to the main branch! 🥳

What's Changed

• chore(deps): bump a bunch of deps by @kanadgupta in #727
• fix(login): better indicators to input project subdomain by @kanadgupta in #728
• chore: bump deps by @kanadgupta in #730
• feat(docs): skip markdown files that lack attributes by @kanadgupta in #729
• ci: use var instead of secret by @kanadgupta in #733
• fix: better logging of API responses by @kanadgupta in #734
• chore(deps): bump simple-git from 3.15.1 to 3.16.0 by @dependabot in #736
• fix: page deletion order in docs:prune by @kanadgupta in #737
• chore(deps): bump by @kanadgupta in #739
• fix(docs): don't merge payloads for PUT requests by @kanadgupta in #740
• ci: fix code coverage in github actions by @erunion in #741
• feat(GHA): add req header containing file URL by @kanadgupta in #735
• refactor(fetch): readmeAPIFetch, consolidate base URL by @kanadgupta in #742

Full Changelog: v8.4.0...8.5.0

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