getsentry
Github Integration Troubleshooting Info
Core or SDK?
Core Sentry product
Which part? Which one?
Release Automation
Description
We've been experiencing an issue installing the Github integration and it turns out the top level Release Automation doc does explain a few things, that Sentry has to be an authorized app of an admin/owner level of the Github organization (though it says repository which is not the case)
and below that at the very bottom there's this non-descript info box that blends in with the links:
I (a non-admin level github account) had originally installed it and had to request approval. It was approved, but not showing as installed. An admin uninstalled it and reinstalled it, but Sentry still wasn't showing it as installed.
It seems like a) there should be a section in the docs dedicated to this behavior, and b) if linking Github to Sentry -before- installing the Github integration is necessary, it seems like that should be enforced or otherwise stated in the integrations page itself.
Suggested Solution
Since the top-level Release Automation docs page isn't Github specific it would probably make sense to either have a sub-section dedicated to it, or an entire sub-page.
Even just putting those two info boxes in the integration description (https://github.com/getsentry/sentry/blob/master/src/sentry/integrations/github/integration.py#L34) itself would be immensely helpful
Also, enforcing the account connection before the integration installation can begin would really be ideal, although I understand that may not be technically feasible.
Thanks for pointing this out @df-pkennedy. I've put this into our backlog for now.
