added

Automatically Sync API Specification with GitHub Actions

Yes, we wanted to launch this feature on Halloween just to use this imageYes, we wanted to launch this feature on Halloween just to use this image

Yes, we wanted to launch this feature on Halloween just to use this image

We just released a GitHub Action for automatically syncing an API Spec file directly from a GitHub repo! GitHub Actions are packages you can include in your GitHub configuration that run whenever certain events happen--such as pushing code to master, opening a pull request, and many more.

GitHub Action UIGitHub Action UI

GitHub Action UI

With our GitHub Actions, you can automatically sync a Swagger or OAS file every time a commit is pushed to master, meaning you no longer have to worry about keeping your docs up to date.

It's super easy to get started! After you join the GitHub Actions beta at https://github.com/features/actions (GitHub just announced it will be generally available November 13th), you just need to copy one file to your repo, add in your ReadMe settings, and that is it!

You can read the docs here to get started: https://docs.readme.com/docs/automatically-sync-api-specification-with-github

Happy Halloween and happy syncing!