bump-sh / github-action

GitHub action to deploy your API documentation on Bump
https://bump.sh
MIT License
41 stars 9 forks source link

Provide validation / warning deployment logs to the user for temporary deploys (diffs) #486

Open paulRbr opened 6 months ago

paulRbr commented 6 months ago

When a user uses the diff feature of the GH action, if may happen that we add warning deployment logs (due to an incorrect input API document, or something we've detected during diff computation). Some logs are not visible to the user because the deployed versions are temporary (and not visible in their Bump.sh workspace).

A potential solution could be to display warning deployment logs in the Github Action comment published on PRs.

Feel free to suggest other solutions in this issue if you have other ideas (it could be stronger validation before the deployment, see https://github.com/bump-sh/cli/issues/5, which could be in a separate workflow step in the CI)