Releases: readmeio/rdme
8.6.5: Versions + Reducer Fixes ⏳
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 #820
- fix(npm): revert shrinkwrap changes by @kanadgupta in #824
- chore(deps): upgrading out of date deps by @erunion in #836
- docs: use updated callout syntax by @kanadgupta in #839
- chore(deps): bump by @kanadgupta in #850
- fix: typo by @kanadgupta in #852
- chore: clean up tsconfig files by @kanadgupta in #854
- fix(openapi/inspect): small url formatting error by @kanadgupta in #855
- fix(versions): general refactors to handle flag edge cases by @kanadgupta in #861
- chore(deps): bump by @kanadgupta in #862
- chore(prettier): upgrading to prettier 3 by @erunion in #864
- chore: add debug statements for
process.chdir
by @kanadgupta in #866 - fix(reducer): quirk with security schemes sometimes getting removed by @erunion in #867
- ci: knip by @kanadgupta in #859
- ci: re-enable tests on node 14 by @kanadgupta in #868
Full Changelog: 8.6.4...8.6.5
8.6.4: GitHub Syncing Fixes 🔄
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 #815 - fix(fetch): encode parameters in source URL by @kanadgupta in #817
- chore(deps): bump by @kanadgupta in #819
- fix(fetch): stricter source URL type-checking by @kanadgupta in #818
Full Changelog: 8.6.3...8.6.4
8.6.4-next.2
What's Changed
- fix(fetch): encode parameters in source URL by @kanadgupta in #817
Full Changelog: 8.6.4-next.1...8.6.4-next.2
8.6.4-next.1
What's Changed
- fix: bump deps to handle
oas
bug by @kanadgupta in #815
Full Changelog: v8.6.3...8.6.4-next.1
8.6.3: Postman Collection conversion fixes
This release makes a small fix to our handling for Postman collections.
What's Changed
- chore(deps): bump by @kanadgupta in #811
- fix(openapi): postman responses without a response now get one by @erunion in #812
Full Changelog: 8.6.2...8.6.3
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 thatrdme
installs with the correct dependency tree 🌲 - A provenance statement, which provides additional transparency around our build process1 ✨
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
-
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 ourpostman-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
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
Full Changelog: v8.6.0-next.13...8.6.0-next.14