Skip to content

8.0.0

Marketplace
Marketplace
Compare
Choose a tag to compare
@kanadgupta kanadgupta released this 31 Oct 18:03
· 482 commits to main since this release
8.0.0
7055dc9

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!

rdme v8.0

What's Changed

Breaking Changes

  • This release completely overhauls the prompts system. Prompts will now automatically error out if prompts are attempted from within a CI environment.
  • If the --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.
  • The validate command has been renamed to openapi:validate. The validate command is now deprecated.
  • The versions command now returns raw JSON as the output and no longer returns a table format.
    • feat(breaking/version): raw versions only, usage cleanup by @kanadgupta in #603
  • The 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
    • feat(breaking/version): raw versions only, usage cleanup by @kanadgupta in #603
  • The 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 #642

  • The docs:edit command has been deprecated and will be removed in an upcoming major release.
  • Simplified various non-versions prompts (e.g., openapi, categories) that previously asked if you wanted to create a new version or use an existing one.
    • Note: This change was marked as breaking but will not break any commands in CI. The only difference is that affected commands will have a slightly simplified prompt question flow.
    • feat(breaking): drop version creation question from prompt flows by @kanadgupta in #635

Other Highlights

  • There is now a new onboarding experience to help you get set up with GitHub Actions. Head over to our blog to get the details!
  • 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.
    • feat: creation of new openapi:reduce command to reduce large OpenAPI definitions by @erunion in #572
  • The 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.
    • feat(breaking/login): remove 2fa flag in favor of better prompts by @kanadgupta in #619
  • If a command requires authentication and the user forgets to pass in an API key via the --key option, the CLI will now prompt the user to log in.
    • feat: prompt for login any time a user omits API key by @kanadgupta in #636
  • The openapi family of commands will now automatically detect your OpenAPI / Swagger definition. See Omitting the File Path in the command reference.
  • The openapi:validate command will now return every error it finds with your API definition, not just the first one it finds.
    • fix(validate): surface all validation errors by @erunion in #639
  • There is now a docs:prune command which will remove any docs from ReadMe that are not in your local directory (thanks @shaiarmis!)
    • feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder by @shaiarmis in #581
    • refactor(docs): move --cleanup option into docs:prune command by @kanadgupta in #644
    • feat(docs:prune): --confirm flag to bypass prompt by @shaiarmis in #648
  • There is now a guides alias for the docs family of commands.
  • Our docs have been completely overhauled! New design, new guidance, and even more examples than before.

Other (Non-Breaking) Highlights

  • feat(logger): add GHA-aware notices/warnings by @kanadgupta in #557
  • feat(openapi): add --create flag by @kanadgupta in #575
  • feat(openapi): add update option to automatically update an only available spec file without any prompts by @shaiarmis in #579
  • feat(docs): Add id to success message response for docs and docs:single by @garrett-wade in #583
  • feat(openapi): add --dryRun option by @darrenyong in #612
  • feat(openapi): raw command output option by @kanadgupta in #613
  • feat(baseCommand): inform user which project they're making changes to by @darrenyong in #643

Other Updates

This release includes various package updates to address security vulnerabilities, in addition to other behind-the-scenes updates.

New Contributors

Full Changelog: 7.5.0...8.0.0

Contributors

erunion, kanadgupta, and 4 other contributors
Assets 2
Loading