Customizing Frogbot Comments on PR Scan results #945
Description
Is your feature request related to a problem? Please describe.
When Frogbot scans a PR/Merge request (in our case, in gitlab), it shows the results of the scan as comments/messages in the PR. The footer of each message that frogbot writes has a link to Frogbot Docs (see image below).
However, the results of the PR scan are mainly viewed by the development team, who are only interested in the results of the scan, not the frogbot configs and docs (since frogbot configurations are more relevant to devops team/repository maintainer).
Describe the solution you'd like to see
Provide the flexibility to change the footer/URL of frogbot PR comments, so that we may, for instance, refer the developers to the internal URL of Xray scan list results where they can see more details and scans history. Or to point them to any relevant URL.
As I can see from the frogbot github repo:
@ frogbot/utils/outputwriter/outputcontent.go, there are some hardcoded variables. Specifically:
- const FrogbotDocumentationUrl = "https://docs.jfrog-applications.jfrog.io/jfrog-applications/frogbot"
- var CommentGeneratedByFrogbot = MarkAsLink("🐸 JFrog Frogbot", FrogbotDocumentationUrl)
At the very least, it would be nice to expose these as ENV variables that we can optionally set.
Any extra customization/flexibility to the PR messages would also be a welcomed addition.
Describe alternatives you've considered
We could add a job in our CI pipeline to add additional comments after frogbot is done scanning, in which we can add any required details. However, it would still be better/neater to customize the frogbot message/footer itself.
Additional context
Add any other context or screenshots about the feature request here.
The frogbot footer:
The variables in "outputcontent.go" that could be exposed as ENV variables possibly:
Adding this feature would be greatly appreciated. Thanks