rdme

ReadMe's official command-line interface (CLI) and GitHub Action 🌊

MIT License

Downloads
313K
Stars
104
Committers
21
View Code on GitHub Visit Website View on X
Ecosystems: OpenAPI Specification

Bot releases are hidden (Show)

rdme -

Published by kanadgupta almost 2 years ago

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'
rdme - 8.0.2

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.

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.1...8.0.2

rdme - 8.0.1

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.

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/v8.0.0...8.0.1

rdme - 8.0.0

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!

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.
  • 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
  • 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 https://github.com/readmeio/rdme/pull/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 https://github.com/readmeio/rdme/pull/635

Other Highlights

Other (Non-Breaking) Highlights

Other Updates

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

New Contributors

Full Changelog: https://github.com/readmeio/rdme/compare/7.5.0...8.0.0

rdme - 7.5.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!

What's Changed

New Contributors

Full Changelog: https://github.com/readmeio/rdme/compare/7.4.0...7.5.0

rdme - 7.4.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!

What's Changed

New Contributors

Full Changelog: https://github.com/readmeio/rdme/compare/7.3.0...7.4.0

rdme - 7.3.0

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.2.2...7.3.0

rdme - 7.2.2

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.2.1...7.2.2

rdme - 7.2.1

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.2.0...7.2.1

rdme - 7.2.0

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.1.1...7.2.0

rdme - 7.1.1

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.1.0...7.1.1

rdme - 7.1.0

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.0.3...7.1.0

rdme - 7.0.3

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.0.2...7.0.3

rdme - 7.0.2

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.0.1...7.0.2

rdme - 7.0.1

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/7.0.0...7.0.1

rdme - 7.0.0

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:

  • Removed the oas command
  • Dropped support for Node 12
  • Dropped support for the --token option in the openapi command

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/6.5.0...7.0.0

rdme - 6.5.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)!

What's Changed

New Contributors

Full Changelog: https://github.com/readmeio/rdme/compare/6.4.0...6.5.0

rdme - 6.4.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.

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/6.3.2...6.4.0

rdme - 6.3.2

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/6.3.1...6.3.2

rdme - 6.3.1

Published by erunion over 2 years ago

What's Changed

Full Changelog: https://github.com/readmeio/rdme/compare/6.3.0...6.3.1

Package Rankings
Top 4.06% on Proxy.golang.org
Top 2.19% on Github actions
Top 2.78% on Npmjs.org
Badges
Extracted from project README
rdme
Related Projects
github-action

GitHub action to deploy your API documentation on Bump

11 Feb 2020 41
redoc

📘 OpenAPI/Swagger-generated API Reference Documentation

30 Oct 2015 22,428
sails-hook-swagger-generator

A tool to help generate Swagger specification documentation based on OAS 3.0 for Sails APIs

08 Aug 2017 78
openapi-format

Format an OpenAPI document by ordering, formatting and filtering fields.

06 Mar 2021 94
redocly-cli

⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.

10 Sep 2019 799
zero-rails_openapi

Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Ruby application.

11 Sep 2017 167
openapi-generator-cli

A node package wrapper for https://github.com/OpenAPITools/openapi-generator

26 Oct 2018 1,430
openapicmd

The CLI for all things OpenAPI and Swagger

26 Jan 2019 43
codegenr

Fast handlebars templates based code generator, ingesting swagger/openapi and other json/yaml doc...

01 Nov 2021 27
redoc

📘 OpenAPI/Swagger-generated API Reference Documentation

30 Oct 2015 22,270
fastify-openapi-glue

A plugin for the Fastify webserver to autogenerate a Fastify configuration based on a OpenApi(v2...

30 Jun 2018 182
api-client-typescript

LaunchDarkly API Client for Typescript Node Server

08 Sep 2017 4
gradle-swagger-generator-plugin

Gradle plugin for OpenAPI YAML validation, code generation and API document publishing

02 Oct 2016 299
rswag

Seamlessly adds a Swagger to Rails-based API's

12 Jan 2015 1,970
swaggerhub-cli

SwaggerHub CLI

06 May 2020 51