ReadMe's official command-line interface (CLI) and GitHub Action 🌊
MIT License
Bot releases are hidden (Show)
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'
Published by kanadgupta almost 2 years ago
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.
Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.1...8.0.2
Published by kanadgupta almost 2 years ago
This release includes a small fix to the GitHub Actions onboarding workflow to prevent the tool from running git commands in CI environments.
Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.0...8.0.1
Published by kanadgupta almost 2 years ago
Happy Halloween y'all! 🎃
We're shipping version 🎱 of rdme
with lots of new features to improve the experience of syncing your docs to ReadMe and setting up your GitHub Actions workflow. Get the details on everything below!
enquirer
to prompts
by @kanadgupta in https://github.com/readmeio/rdme/pull/570
--version
option (used in the openapi
command and the docs
family of commands) is omitted in a CI environment, no version information will be sent in the request to the ReadMe API. This will typically result in the API defaulting to the default (i.e., stable) version.
validate
command has been renamed to openapi:validate
. The validate
command is now deprecated.
validate
to openapi:validate
by @kanadgupta in https://github.com/readmeio/rdme/pull/598
versions
command now returns raw JSON as the output and no longer returns a table format.
versions:update
command now accepts the version
parameter as the default option (rather than via a --version
flag) so the usage is consistent with versions:create
and versions:delete
changelogs:single
, custompages:single
, and docs:single
commands have been removed in favor of their non-single counterparts (i.e., the changelogs
, custompages
, and docs
commands), which have been simplified to support both single files and directories containing the files you wish to sync.
For example, if this was your command in v7:
rdme changelogs:single file.md
it will look like this in v8:
rdme changelogs file.md
feat(docs): consolidate single
commands by @kanadgupta in https://github.com/readmeio/rdme/pull/642
docs:edit
command has been deprecated and will be removed in an upcoming major release.
docs:edit
by @kanadgupta in https://github.com/readmeio/rdme/pull/646
versions
prompts (e.g., openapi
, categories
) that previously asked if you wanted to create a new version or use an existing one.
rdme
now includes a new openapi:reduce
command which allows you to reduce a large API definition down to a specific set of tags or paths. This can be useful if you're debugging a problematic schema somewhere, or if you have a file that is too big to maintain.
openapi:reduce
command to reduce large OpenAPI definitions by @erunion in https://github.com/readmeio/rdme/pull/572
login
command no longer requires the --2fa
flag for users with two-factor authentication enabled. The CLI will instead will prompt users for their 2FA code if their account necessitates it.
2fa
flag in favor of better prompts by @kanadgupta in https://github.com/readmeio/rdme/pull/619
--key
option, the CLI will now prompt the user to log in.
openapi
family of commands will now automatically detect your OpenAPI / Swagger definition. See Omitting the File Path in the command reference.
openapi:validate
command will now return every error it finds with your API definition, not just the first one it finds.
docs:prune
command which will remove any docs from ReadMe that are not in your local directory (thanks @shaiarmis!)
--cleanup
option into docs:prune
command by @kanadgupta in https://github.com/readmeio/rdme/pull/644
guides
alias for the docs
family of commands.
guides
alias by @kanadgupta in https://github.com/readmeio/rdme/pull/647
--create
flag by @kanadgupta in https://github.com/readmeio/rdme/pull/575
update
option to automatically update an only available spec file without any prompts by @shaiarmis in https://github.com/readmeio/rdme/pull/579
docs
and docs:single
by @garrett-wade in https://github.com/readmeio/rdme/pull/583
--dryRun
option by @darrenyong in https://github.com/readmeio/rdme/pull/612
This release includes various package updates to address security vulnerabilities, in addition to other behind-the-scenes updates.
@npmcli/ci-detect
by @kanadgupta in https://github.com/readmeio/rdme/pull/569
openapi
): fix a few incorrect mocks by @kanadgupta in https://github.com/readmeio/rdme/pull/584
create
flag edge case by @kanadgupta in https://github.com/readmeio/rdme/pull/585
npm init
alias by @kanadgupta in https://github.com/readmeio/rdme/pull/597
_id
param by @kanadgupta in https://github.com/readmeio/rdme/pull/616
create
attempt by @kanadgupta in https://github.com/readmeio/rdme/pull/620
Full Changelog: https://github.com/readmeio/rdme/compare/7.5.0...8.0.0
Published by erunion about 2 years ago
In v7.5, we finally ship support for several long-requested features—Changelog and Custom Pages! The functionality is nearly identical to that of the docs
command—pass in a directory of Markdown (or in the case of Custom Pages, Markdown or HTML), and rdme
will magically sync it to your ReadMe project. Get the details in our docs!
category
to cmdCategory
in Command
class by @kanadgupta in https://github.com/readmeio/rdme/pull/544
Full Changelog: https://github.com/readmeio/rdme/compare/7.4.0...7.5.0
Published by erunion about 2 years ago
In this release, we add commands for Categories, as well as a docs:single
command for syncing individual Markdown files. Thanks @garrett-wade!
pull_request
event by @kanadgupta in https://github.com/readmeio/rdme/pull/531
docs:single
by @garrett-wade in https://github.com/readmeio/rdme/pull/529
--2fa
option by @kanadgupta in https://github.com/readmeio/rdme/pull/537
categories
and categories:create
by @garrett-wade in https://github.com/readmeio/rdme/pull/530
Full Changelog: https://github.com/readmeio/rdme/compare/7.3.0...7.4.0
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.2.2...7.3.0
Published by erunion over 2 years ago
.yml
when auto-detecting OAS by @kanadgupta in https://github.com/readmeio/rdme/pull/517
Full Changelog: https://github.com/readmeio/rdme/compare/7.2.1...7.2.2
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.2.0...7.2.1
Published by erunion over 2 years ago
rdme
version by @kanadgupta in https://github.com/readmeio/rdme/pull/493
Full Changelog: https://github.com/readmeio/rdme/compare/7.1.1...7.2.0
Published by erunion over 2 years ago
docs
): clarify slug handling by @kanadgupta in https://github.com/readmeio/rdme/pull/491
Full Changelog: https://github.com/readmeio/rdme/compare/7.1.0...7.1.1
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.0.3...7.1.0
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.0.2...7.0.3
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.0.1...7.0.2
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/7.0.0...7.0.1
Published by erunion over 2 years ago
v7 of rdme
is a massive release that includes first-class GitHub Actions support, a new dry run flag for the docs
command, and lots of improvements to our documentation. This release includes several breaking changes:
oas
command--token
option in the openapi
command--dryRun
option by @kanadgupta in https://github.com/readmeio/rdme/pull/454
token
parameter by @kanadgupta in https://github.com/readmeio/rdme/pull/451
readme-oas-key
by @kanadgupta in https://github.com/readmeio/rdme/pull/464
chalk
overrides from error annotations by @kanadgupta in https://github.com/readmeio/rdme/pull/466
oas
command by @kanadgupta in https://github.com/readmeio/rdme/pull/448
alex
to ensure we're using inclusive language by @kanadgupta in https://github.com/readmeio/rdme/pull/469
actions/setup-node
by @kanadgupta in https://github.com/readmeio/rdme/pull/476
Full Changelog: https://github.com/readmeio/rdme/compare/6.5.0...7.0.0
Published by erunion over 2 years ago
With this release, we are officially shipping first-class support for GitHub Actions within rdme
🚀 this means you can use the power of rdme
to sync your OpenAPI definitions and Markdown files to ReadMe any time you make changes on GitHub.
Alongside this change, this release includes debugging support, major documentation updates, and support for relative external references when syncing OpenAPI definitions (thanks @jdecool)!
Full Changelog: https://github.com/readmeio/rdme/compare/6.4.0...6.5.0
Published by erunion over 2 years ago
With this release we have also formally deprecated all releases below 6.4.0
. If you're on any version that isn't the latest we highly recommend you upgrade to take advantage of our new support for OpenAPI 3.1, pre-upload API definition validation, and clearer error messages.
Full Changelog: https://github.com/readmeio/rdme/compare/6.3.2...6.4.0
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/6.3.1...6.3.2
Published by erunion over 2 years ago
Full Changelog: https://github.com/readmeio/rdme/compare/6.3.0...6.3.1