{"repo":"bump-sh/github-action","free":true,"listed":false,"github":"https://github.com/bump-sh/github-action","clone":"git clone https://github.com/bump-sh/github-action.git","description":"GitHub action to deploy your API documentation on Bump","language":"TypeScript","stars":47,"topics":["api-documentation","github-actions","openapi","openapi-specification","asyncapi","asyncapi-specification"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Deploy API documentation at each code commit, and review diffs Help Sign up Bump.sh helps you build a branded single source of truth, cataloging all your APIs. We’ve created the reference point for teams consuming and building APIs, no matter which technology they rely on. Bump.sh keeps your API docs always synchronized with your codebase. With this Github Action your API reference is automatically generated - with changelog and diff - on Bump.sh from any OpenAPI or AsyncAPI file. You can also use this GitHub action to generate and manage MCP server, based on any Arazzo or Flower file. Table of contents Usage Inputs Contributing License Code Of Conduct Usage Start with creating a documentation on Bump.sh. Once you've got an API Documentation set up, go to Settings CI Deployment, copy the access token, then add it to GitHub Settings Secrets Actions as a new environment variable called BUMP TOKEN . Then you can pick from one of the three following API workflow files. - Recommended: Deploy documentation & diff on pull requests - Deploy documentation only - Diff on pull requests only This GitHub action can be utilized to interact with the MCP server and workflow definition hosted on Bump.sh: - Deploy workflow document for your MCP server Deploy documentation & diff on pull requests This is the most common worklow that we recommend using, which will create two steps in your automation flow: a validation & diff step on code reviews, followed by a deployment step on merged changes. ","default_branch":null,"files":null,"tree":[],"storefront":"/r/bump-sh","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/bump-sh/github-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}