8.2.0

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¹. 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 #677
• docs: update version/category to reflect new location by @kanadgupta in #678
• feat: proxy support by @kanadgupta in #681
• feat: major version tags by @kanadgupta in #682

Full Changelog: v8.1.1...8.2.0

1. We use SemVer conventions for versioning rdme. ↩

8.1.1

What's Changed

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

Full Changelog: v8.1.0...8.1.1

8.1.0

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

Full Changelog: v8.0.4...8.1.0

8.0.4

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'

8.0.2

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.

What's Changed

• fix: npm script awareness, TS fixes, test env refactors by @kanadgupta in #659

Full Changelog: v8.0.1...8.0.2

8.0.1

This release includes a small fix to the GitHub Actions onboarding workflow to prevent the tool from running git commands in CI environments.

What's Changed

• chore(deps): bump @npmcli/ci-detect from 3.0.0 to 3.0.1 by @dependabot in #654
• chore(deps-dev): bump @readme/oas-examples from 5.7.0 to 5.8.0 by @dependabot in #656
• chore(deps): bump a bunch of deps by @kanadgupta in #658
• fix(gha-onboarding): don't run git commands in CI by @kanadgupta in #657

Full Changelog: v8.0.0...8.0.1

8.0.0

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!

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.
  • refactor: migrate from enquirer to prompts by @kanadgupta in #570
  • chore(prompt): various enhancements and refactors by @kanadgupta in #576
• 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.
  • feat(openapi): version handling improvements by @kanadgupta in #559
• The validate command has been renamed to openapi:validate. The validate command is now deprecated.
  • feat: migrate validate to openapi:validate by @kanadgupta in #598
• 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.
  • feat(breaking/docs): deprecate docs:edit by @kanadgupta in #646
• 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!
  • feat(GHA): workflow file creation onboarding by @kanadgupta in #577
• 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.
  • feat(openapi): auto-detect API definitions by @kanadgupta in #567
• 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.
  • feat(docs): add guides alias by @kanadgupta in #647
• Our docs have been completely overhauled! New design, new guidance, and even more examples than before.
  • docs: v8 docs by @kanadgupta in #637

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.

• chore(deps-dev): bump jest from 28.1.2 to 28.1.3 by @dependabot in #552
• chore(deps-dev): bump nock from 13.2.8 to 13.2.9 by @dependabot in #554
• chore(deps-dev): bump @readme/oas-examples from 5.4.0 to 5.5.0 by @dependabot in #555
• refactor(openapi): DRY and logic reorg by @kanadgupta in #556
• feat: typescript rewrite by @erunion in #560
• feat: add prettier formatting check for markdown by @kanadgupta in #561
• refactor: consolidate auth checks by @kanadgupta in #562
• feat: minor refactor of how we debug and log out data in commands by @erunion in #563
• feat: upgrading oas-normalize to pull in its new TS typings by @erunion in #564
• ci: optimize test runs and add docs syncing dry run by @kanadgupta in #565
• fix: quieter log outputs when installing GHA by @kanadgupta in #566
• chore(deps-dev): bring in types for @npmcli/ci-detect by @kanadgupta in #569
• chore(deps): bump @actions/core from 1.9.0 to 1.9.1 by @dependabot in #571
• feat: experiment with a decorator to hide commands from the help s...

7.5.0

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!

What's Changed

• refactor(docs): consolidate logic by @kanadgupta in #540
• refactor: split out fixtures, test cleanup by @kanadgupta in #542
• feat: changelog endpoints by @kanadgupta in #543
• refactor: rename category to cmdCategory in Command class by @kanadgupta in #544
• feat: add retag-release workflow to add a vX.Y.Z tag for our GitHub Action by @RyanGWU82 in #545
• feat: custom pages support by @kanadgupta in #547
• docs: guidance on custompages + changelog by @kanadgupta in #548

New Contributors

• @RyanGWU82 made their first contribution in #545

Full Changelog: 7.4.0...7.5.0

7.4.0

In this release, we add commands for Categories, as well as a docs:single command for syncing individual Markdown files. Thanks @garrett-wade!

What's Changed

• ci: run tests on pull_request event by @kanadgupta in #531
• chore(deps-dev): bump jest from 28.1.1 to 28.1.2 by @dependabot in #532
• chore(deps-dev): bump nock from 13.2.7 to 13.2.8 by @dependabot in #534
• feat: add docs:single by @garrett-wade in #529
• feat(config): add ability to override host + hub by @kanadgupta in #535
• fix(openapi): clearer copy, smol refactors by @kanadgupta in #536
• docs: add some language on --2fa option by @kanadgupta in #537
• feat: better error-handling for non-JSON responses by @kanadgupta in #538
• feat: add categories and categories:create by @garrett-wade in #530

New Contributors

• @garrett-wade made their first contribution in #529

Full Changelog: 7.3.0...7.4.0

7.3.0

What's Changed

• ci(CodeQL): add config by @kanadgupta in #521
• perf(openapi): upload improvements by @kanadgupta in #518
• chore(deps-dev): bump @readme/oas-examples from 5.3.0 to 5.4.0 by @dependabot in #524
• test(openapi/validate): cleanup 🧹 by @kanadgupta in #520
• chore(deps): bump @actions/core from 1.8.2 to 1.9.0 by @dependabot in #527

Full Changelog: 7.2.2...7.3.0