Documentation request: Create events catalog for easy look-up when creating CD integrations

[aristapimenta]

I followed this guide https://fluxcd.io/flux/use-cases/gh-actions-helm-promotion/ and it suggests using Alert and GitHub Dispatch for promoting HelmReleases. It works great for me, but the way with how you select events (an exclusion regex list) is complex and made me think that it would be great if there was a neat catalog of events. I didn't find any such documentation and right now I'm basically looking up the Flux source code to figure out which events I would benefit from.

[aristapimenta]

This could probably be generated automatically.

[somtochiama]

Just to clarify, you mean a list of events that each of the controllers sends to notification-controller?

[aristapimenta]

Just to clarify, you mean a list of events that each of the controllers sends to notification-controller?

Hi @somtochiama! Yep, that's exactly what I mean. I think this would greatly help harvesting the potential of notification-controller, because today there isn't an easy way to know what events you could be hooking to/benefiting from.

I work on an enterprise product whose build process extracts log documentation directly from comments in the source code properly placed around/before the log line/function call. I think there's a similarity between what these logs and the Flux events achieve, so I thought about this catalog suggestion.