rdme

The 8.6.5 release introduced a small regression when attempting to set the main flag to true via the versions:create or versions:update commands. This release fixes that. Thanks @svrnwnsch for reporting!

What's Changed

• fix(versions): fix ability to set main version by @kanadgupta in https://github.com/readmeio/rdme/pull/872
• docs(versions/create): backfill missing flag by @kanadgupta in https://github.com/readmeio/rdme/pull/869

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.5...8.6.6

This release includes fixes to the versions:create and versions:update commands where these commands were not setting flags correctly in certain cases. This release also includes a tiny fix to the openapi:reduce command and updates a slew of npm dependencies.

What's Changed

• chore(eslint): consistenly sorting on interface props by @erunion in https://github.com/readmeio/rdme/pull/820
• fix(npm): revert shrinkwrap changes by @kanadgupta in https://github.com/readmeio/rdme/pull/824
• chore(deps): upgrading out of date deps by @erunion in https://github.com/readmeio/rdme/pull/836
• docs: use updated callout syntax by @kanadgupta in https://github.com/readmeio/rdme/pull/839
• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/850
• fix: typo by @kanadgupta in https://github.com/readmeio/rdme/pull/852
• chore: clean up tsconfig files by @kanadgupta in https://github.com/readmeio/rdme/pull/854
• fix(openapi/inspect): small url formatting error by @kanadgupta in https://github.com/readmeio/rdme/pull/855
• fix(versions): general refactors to handle flag edge cases by @kanadgupta in https://github.com/readmeio/rdme/pull/861
• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/862
• chore(prettier): upgrading to prettier 3 by @erunion in https://github.com/readmeio/rdme/pull/864
• chore: add debug statements for process.chdir by @kanadgupta in https://github.com/readmeio/rdme/pull/866
• fix(reducer): quirk with security schemes sometimes getting removed by @erunion in https://github.com/readmeio/rdme/pull/867
• ci: knip by @kanadgupta in https://github.com/readmeio/rdme/pull/859
• ci: re-enable tests on node 14 by @kanadgupta in https://github.com/readmeio/rdme/pull/868

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.4...8.6.5

This release fixes an edge case with certain file paths when syncing docs from GitHub. Thanks @vegaro for reporting!

What's Changed

• fix: bump deps to handle oas bug by @kanadgupta in https://github.com/readmeio/rdme/pull/815
• fix(fetch): encode parameters in source URL by @kanadgupta in https://github.com/readmeio/rdme/pull/817
• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/819
• fix(fetch): stricter source URL type-checking by @kanadgupta in https://github.com/readmeio/rdme/pull/818

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.3...8.6.4

What's Changed

• fix(fetch): encode parameters in source URL by @kanadgupta in https://github.com/readmeio/rdme/pull/817

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.4-next.1...8.6.4-next.2

What's Changed

• fix: bump deps to handle oas bug by @kanadgupta in https://github.com/readmeio/rdme/pull/815

Full Changelog: https://github.com/readmeio/rdme/compare/v8.6.3...8.6.4-next.1

This release makes a small fix to our handling for Postman collections.

What's Changed

• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/811
• fix(openapi): postman responses without a response now get one by @erunion in https://github.com/readmeio/rdme/pull/812

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.2...8.6.3

In this release, we fixed a bug where openapi:reduce would fail to reduce certain files (https://github.com/readmeio/rdme/pull/802, https://github.com/readmeio/oas/pull/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[^1] ✨

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 https://github.com/readmeio/rdme/pull/800
• fix(deps): bump oas (and others) by @kanadgupta in
• fix(npm): use shrinkwrap instead of lockfile by @kanadgupta in https://github.com/readmeio/rdme/pull/803

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.1...8.6.2

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

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 https://github.com/readmeio/rdme/pull/786
• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/795
• chore: remove outdated oas language, testbed cleanup 🧹 by @kanadgupta in https://github.com/readmeio/rdme/pull/796
• fix(docker): safer argument parsing for GitHub Actions by @kanadgupta in https://github.com/readmeio/rdme/pull/788
• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/797

Full Changelog: https://github.com/readmeio/rdme/compare/8.6.0...8.6.1

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:

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 https://github.com/readmeio/rdme/pull/763
• fix: upgrading oas-normalize to move to our postman-to-openapi fork by @erunion in https://github.com/readmeio/rdme/pull/776
• perf(docker): build executable by @kanadgupta in https://github.com/readmeio/rdme/pull/764
• fix(openapi): yaml strings would be improperly parsed as Date objects by @erunion in https://github.com/readmeio/rdme/pull/779
• feat: container registry by @kanadgupta in https://github.com/readmeio/rdme/pull/777
• feat: add GHA output with command result by @kanadgupta in https://github.com/readmeio/rdme/pull/781
• fix(openapi): memory leak in large file handling within oas-normalize by @erunion in https://github.com/readmeio/rdme/pull/784

Full Changelog: https://github.com/readmeio/rdme/compare/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!

What's Changed

• chore(deps): bump by @kanadgupta in https://github.com/readmeio/rdme/pull/782
• feat: add GHA output with command result by @kanadgupta in https://github.com/readmeio/rdme/pull/781
• fix(openapi): memory leak in large file handling within oas-normalize by @erunion in https://github.com/readmeio/rdme/pull/784

Full Changelog: https://github.com/readmeio/rdme/compare/v8.6.0-next.16...8.6.0-next.17

The v8 tag will be updated any time we update our main channel for version 8 🎱

Note
We strongly recommend using this tag in your GitHub Actions workflows (as opposed to staying on a fixed version like 8.5.0). That way, your workflows remain up-to-date without the risk of breaking changes[^1] that disrupt your workflows. Plus, you can avoid those pesky Dependabot notifications for minor or patch updates!

Here's an example of how you'd use this v8 tag in your workflows:

- name: Validate with rdme 🦉
  uses: readmeio/rdme@v8
  with:
    rdme: openapi:validate petstore.json

[^1]: This is because rdme follows semantic versioning conventions.

What's Changed

• fix(openapi): yaml strings would be improperly parsed as Date objects by @erunion in https://github.com/readmeio/rdme/pull/779

Full Changelog: https://github.com/readmeio/rdme/compare/v8.6.0-next.13...8.6.0-next.14

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

Full Changelog: https://github.com/readmeio/rdme/compare/v8.4.0...8.5.0

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

• https://github.com/readmeio/rdme/pull/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

• https://github.com/readmeio/rdme/pull/717 adds a new command called openapi:convert for converting Swagger 2.0 definitions and Postman Collections into OpenAPI.
• https://github.com/readmeio/rdme/pull/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).
• https://github.com/readmeio/rdme/pull/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:

https://user-images.githubusercontent.com/8854718/208739413-590aa265-072d-4800-bca1-27f281448017.mp4

What's Changed

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

Full Changelog: https://github.com/readmeio/rdme/compare/v8.3.1...8.4.0

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 https://github.com/readmeio/rdme/pull/712
• fix(docs:prune): prune child docs by @kanadgupta in https://github.com/readmeio/rdme/pull/713

Full Changelog: https://github.com/readmeio/rdme/compare/v8.3.0...8.3.1

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 https://github.com/readmeio/rdme/pull/698
• chore(deps-dev): bumping dev deps and resolving type -> interface conversions by @erunion in https://github.com/readmeio/rdme/pull/708
• feat: dropping our position system for ordering commands in --help by @erunion in https://github.com/readmeio/rdme/pull/707
• feat: ability to pass in API key via env vars by @kanadgupta in https://github.com/readmeio/rdme/pull/709

Full Changelog: https://github.com/readmeio/rdme/compare/v8.2.1...8.3.0

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 https://github.com/readmeio/rdme/pull/684
• chore(deps): bump a bunch of deps by @kanadgupta in https://github.com/readmeio/rdme/pull/695
• ci: caching deps in ci by @erunion in https://github.com/readmeio/rdme/pull/696
• docs: better callout for rdme login usage by @kanadgupta in https://github.com/readmeio/rdme/pull/699
• test: cleaning up our jest config by @erunion in https://github.com/readmeio/rdme/pull/700
• fix(createGHA): git remote connection errors by @kanadgupta in https://github.com/readmeio/rdme/pull/705

Full Changelog: https://github.com/readmeio/rdme/compare/v8.2.0...8.2.1

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[^1]. 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 https://github.com/readmeio/rdme/pull/677
• docs: update version/category to reflect new location by @kanadgupta in https://github.com/readmeio/rdme/pull/678
• feat: proxy support by @kanadgupta in https://github.com/readmeio/rdme/pull/681
• feat: major version tags by @kanadgupta in https://github.com/readmeio/rdme/pull/682

Full Changelog: https://github.com/readmeio/rdme/compare/v8.1.1...8.2.0

[^1]: We use SemVer conventions for versioning rdme.

What's Changed

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

Full Changelog: https://github.com/readmeio/rdme/compare/v8.1.0...8.1.1

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 https://github.com/readmeio/rdme/pull/666
• feat: adding support for uploading and validating Postman collections by @erunion in https://github.com/readmeio/rdme/pull/669
• fix(createGHA): remove non-github remote check by @kanadgupta in https://github.com/readmeio/rdme/pull/665
• fix: upgrade oas-normalize to fix a postman conversion issue by @erunion in https://github.com/readmeio/rdme/pull/672
• fix: swap out @npmcli/ci-detect for ci-info by @kanadgupta in https://github.com/readmeio/rdme/pull/667
• feat: postman-related enhancements, output cleanup by @kanadgupta in https://github.com/readmeio/rdme/pull/673

Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.4...8.1.0