6.5.0

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)!

What's Changed

• feat: add wrapper for GitHub Actions by @kanadgupta in #437
• docs: run VSCode formatter, fix TOC by @kanadgupta in #438
• docs: update Action metadata by @kanadgupta in #441
• docs: add contributing guidelines by @kanadgupta in #442
• feat: add GitHub-specific request headers by @kanadgupta in #443
• feat: debugging support by @kanadgupta in #446
• feat: add workdir arg to openapi command by @jdecool in #450
• docs(openapi): update working directory usage by @kanadgupta in #453
• docs: add GitHub Actions guidance by @kanadgupta in #439
• docs: legacy GitHub Action docs by @kanadgupta in #452

New Contributors

• @jdecool made their first contribution in #450

Full Changelog: 6.4.0...6.5.0

6.4.0

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.

What's Changed

• feat: add update-notifier to warn when using an old version of rdme by @domharrington in #435
• feat: sending a custom rdme user agent with all requests by @erunion in #436

Full Changelog: 6.3.2...6.4.0

6.3.2

What's Changed

• chore(deps): bump command-line-args from 5.2.0 to 5.2.1 by @dependabot in #428
• chore(deps-dev): bump nock from 13.2.1 to 13.2.2 by @dependabot in #429
• chore(deps-dev): bump jest from 27.4.5 to 27.4.7 by @dependabot in #430
• chore(deps-dev): bump eslint from 8.6.0 to 8.8.0 by @dependabot in #431
• chore(deps-dev): bump @readme/oas-examples from 4.3.3 to 4.4.0 by @dependabot in #432
• chore(deps): bump config from 3.3.3 to 3.3.7 by @dependabot in #433
• chore(deps-dev): bump @readme/eslint-config from 8.1.1 to 8.2.0 by @dependabot in #434

Full Changelog: 6.3.1...6.3.2

6.3.1

What's Changed

• chore(deps): bumping the oas parser to fix a bug with header validation by @erunion in #426
• chore(deps): bump node-fetch from 2.6.6 to 2.6.7 by @dependabot in #427

Full Changelog: 6.3.0...6.3.1

6.3.0

What's Changed

• ci: tweak ESLint config, small refactors by @kanadgupta in #422
• fix: quirks with version commands and config retrieval by @erunion in #423
• refactor: commands into command classes by @erunion in #424

Full Changelog: 6.2.1...6.3.0

6.2.1

What's Changed

• fix(docs): directory sync fix + test bed rewrites by @kanadgupta in #421

Full Changelog: 6.2.0...6.2.1

6.2.0

🚦 This includes some upgrades to our internal OpenAPI/Swagger definition parsing engine, @readme/openapi-parser, to expand validation to a number of new aspects of the specifications:

• Duplicate parameters
• Paths with parameters with no parameter schemas
• Duplicate operation IDs
• Invalid discriminators
• type: array with no items
• And more...

If you have issues with any of these new validations please reach out to us either through an rdme GitHub ticket or our support team at [email protected]

What's Changed

• refactor(open/openapi/validate): return promises, fix tests by @kanadgupta in #410
• fix(openapi): error handling for incorrect project and version flags by @kanadgupta in #411
• chore(deps-dev): bump jest from 27.4.3 to 27.4.5 by @dependabot in #419
• chore(deps-dev): bump eslint from 8.3.0 to 8.6.0 by @dependabot in #418
• chore(deps): bump oas from 17.3.1 to 17.4.0 by @dependabot in #417
• chore(deps-dev): bump @readme/eslint-config from 8.0.2 to 8.1.1 by @dependabot in #416
• chore(deps-dev): bump prettier from 2.5.0 to 2.5.1 by @dependabot in #415
• chore(deps): bump cli-table from 0.3.9 to 0.3.11 by @dependabot in #414
• chore(deps): bump actions/setup-node from 2.5.0 to 2.5.1 by @dependabot in #413
• chore(deps): bump parse-link-header from 1.0.1 to 2.0.0 by @dependabot in #412
• chore(deps): upgrading oas-related deps by @erunion in #420

Full Changelog: 6.1.3...6.2.0

6.1.3

What's Changed

• fix(openapi): return rejected Promise if spec uploads fail by @kanadgupta in #409

Full Changelog: 6.1.2...6.1.3

6.1.2

What's Changed

• docs: add/improve our command warnings by @kanadgupta in #406
• ci: drop the npm@7 requirement before installing deps in ci by @erunion in #408

Full Changelog: 6.1.1...6.1.2

6.1.1

What's Changed

• feat(versions): stringify JSON for --raw option by @kanadgupta in #404
• docs: add docs on validation, fix TOC by @kanadgupta in #405

Full Changelog: 6.1.0...6.1.1