Releases · readmeio/github-readme-sync

This repository was archived by the owner on Mar 25, 2022. It is now read-only.

01 Mar 01:49

2.1.3

e3e7be4

Deprecated in favor of our new GitHub Action! Latest

Latest

This GitHub Action repository is now deprecated in favor of rdme, which has GitHub Action support for syncing OpenAPI files, directories of Markdown files, and more. Workflows using this repository will continue to function normally, but development and support related this repository is now closed and this repository is archived. Check out our docs to learn more!

Assets 2

21 Oct 15:43

kanadgupta

2.1.2

4dd2012

ReadMe Base URL Update

This updates our base URL to dash.readme.com to reflect our latest guidance on accessing the ReadMe API.

Assets 2

27 Oct 23:26

kanadgupta

2.1.1

caf497e

Validation enhancements, other minor bug fixes

This resolves some issues introduced in v2.1.0 with OpenAPI/Swagger file validation. The validation is now performed by the ReadMe API during upload, rather than performing a validation beforehand.

Additionally, this fixes some false positives in the workflow's error handling.

Assets 2

19 Oct 19:21

kanadgupta

2.1.0

54bba62

OpenAPI/Swagger validation, Step Debug Logs, and more!

Highlights of this release include:

OpenAPI/Swagger file validation prior to upload
Step Debug Logs for troubleshooting workflow failures
Error messages — now with 100% more clarity and whimsy! (Be sure to check out our blog post on why we did this)
- This should also resolve issues that folks may have been seeing with unhelpful error messages (e.g. #23)

This release also includes minor housekeeping, such as bumping various dependencies and removing extraneous ones.

Assets 2

13 Jul 20:22

mjcuva

2.0.0

c6e52d1

Version 2.0: Simplified setup and configuration!

This is a big release to our GitHub Action! We've dramatically simplified the configuration required and try to infer as much as possible.

Now there is only one required parameter,readme-oas-key which can be obtained from the ReadMe dashboard when initially syncing your API.

There are two optional parameters that can be passed in:

oas-file-path: path to the spec file to be synced (Default: we try to find a file automatically)
api-version: version in ReadMe to sync the API spec to (Default: version defined within the spec file)

Assets 2