Skip to content

Add preview documentation link in pull request comment

Choose a tag to compare

@paulRbr paulRbr released this 01 Mar 11:27
060fc2a

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 the file: input parameter to target a directory. Don't forget to remove an existing doc: input parameter πŸ™‚.

Have fun documenting APIs ✨