ReadMe's official command-line interface (CLI) and GitHub Action ๐
MIT License
Bot releases are visible (Hide)
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!
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.5...8.6.6
Published by kanadgupta about 1 year ago
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.
process.chdir
by @kanadgupta in https://github.com/readmeio/rdme/pull/866
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.4...8.6.5
Published by kanadgupta over 1 year ago
This release fixes an edge case with certain file paths when syncing docs from GitHub. Thanks @vegaro for reporting!
oas
bug by @kanadgupta in https://github.com/readmeio/rdme/pull/815
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.3...8.6.4
Published by kanadgupta over 1 year ago
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.4-next.1...8.6.4-next.2
Published by kanadgupta over 1 year ago
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
Published by kanadgupta over 1 year ago
This release makes a small fix to our handling for Postman collections.
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.2...8.6.3
Published by kanadgupta over 1 year ago
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:
npm-shrinkwrap.json
file, which ensures that rdme
installs with the correct dependency tree ๐ฒ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 ๐
oas
(and others) by @kanadgupta inFull 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
Published by kanadgupta over 1 year ago
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).
oas
language, testbed cleanup ๐งน by @kanadgupta in https://github.com/readmeio/rdme/pull/796
Full Changelog: https://github.com/readmeio/rdme/compare/8.6.0...8.6.1
Published by kanadgupta over 1 year ago
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 | Before[^1] | After[^1] |
---|---|---|
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.
oas-normalize
to move to our postman-to-openapi
fork by @erunion in https://github.com/readmeio/rdme/pull/776
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!
Published by kanadgupta over 1 year ago
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
Published by kanadgupta over 1 year ago
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 like8.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.
Published by kanadgupta over 1 year ago
Full Changelog: https://github.com/readmeio/rdme/compare/v8.6.0-next.13...8.6.0-next.14
Published by kanadgupta over 1 year ago
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! ๐ฅณ
docs:prune
by @kanadgupta in https://github.com/readmeio/rdme/pull/737
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
Published by kanadgupta almost 2 years ago
This release adds an openapi:convert
command, documentation on our new 1Password shell plugin, and more. See below for the highlights:
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
openapi:convert
for converting Swagger 2.0 definitions and Postman Collections into OpenAPI.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).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
:convert
command by @erunion in https://github.com/readmeio/rdme/pull/717
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
Published by kanadgupta almost 2 years ago
This release adds the ability to pass flags into login
and resolves a bug with docs:prune
.
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
Published by kanadgupta almost 2 years ago
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.
openapi:inspect
command by @erunion in https://github.com/readmeio/rdme/pull/698
position
system for ordering commands in --help
by @erunion in https://github.com/readmeio/rdme/pull/707
Full Changelog: https://github.com/readmeio/rdme/compare/v8.2.1...8.3.0
Published by kanadgupta almost 2 years ago
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.
openapi:reduce
): pass opts by @kanadgupta in https://github.com/readmeio/rdme/pull/684
rdme login
usage by @kanadgupta in https://github.com/readmeio/rdme/pull/699
Full Changelog: https://github.com/readmeio/rdme/compare/v8.2.0...8.2.1
Published by kanadgupta almost 2 years ago
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.
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]
Full Changelog: https://github.com/readmeio/rdme/compare/v8.1.1...8.2.0
[^1]: We use SemVer conventions for versioning rdme
.
Published by kanadgupta almost 2 years ago
rdme open
should have a flag for opening the dash by @darrenyong in https://github.com/readmeio/rdme/pull/671
Full Changelog: https://github.com/readmeio/rdme/compare/v8.1.0...8.1.1
Published by kanadgupta almost 2 years ago
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.
@npmcli/ci-detect
for ci-info
by @kanadgupta in https://github.com/readmeio/rdme/pull/667
Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.4...8.1.0