This release includes two main improvements
π Add preview documentation links in pull request comment
- π¨οΈπ When GitHub comments on pull requests are enabled to shared the diff of an API document change, the comment now includes a link to preview the documentation with the latest changes. π Perfect to check the documentation before merging your changes!
π Deploy an entire directory of multiple API documents to a Bump.sh Hub
-
ππ You can now deploy an entire directory of API documents to a Bump.sh hub. This was added in the CLI but was not yet possible with the GitHub action. For now the default filename-pattern is used (
{slug}-api.[json|yaml]so your API documents following this filename pattern will be deployed to your target hub)To do so, you will need to use the
hub:input parameter of the GitHub action, and change thefile:input parameter to target a directory. Don't forget to remove an existingdoc:input parameter π.
Have fun documenting APIs β¨