feat: add function to create a more speaking id for commit status #705
Conversation
sebbrandt87
force-pushed
the
feat/gitlab-commit-status-event-label-usage
branch
2 times, most recently
from
ecbcebf
to
9a7daac
Compare
There was a problem hiding this comment.
This change needs to be accompanied by documentation. I'm also not sure how much we're bought into the current format as people might already be relying on it as it is right now. @stefanprodan?
| @@ -59,10 +59,29 @@ func formatNameAndDescription(event eventv1.Event) (string, string) { | |||
| // involved object kind and name. | |||
| func generateCommitStatusID(providerUID string, event eventv1.Event) string { | |||
| uidParts := strings.Split(providerUID, "-") | |||
| id := fmt.Sprintf("%s/%s/%s", event.InvolvedObject.Kind, event.InvolvedObject.Name, uidParts[0]) | |||
| metadataLabelsSuffix := createMetadataLabelsSuffix(event) | |||
There was a problem hiding this comment.
This has the potential to result in a very long string which is undesirable. We need to think on a way to constrain this to a certain length.
There was a problem hiding this comment.
true, it might be an option to change eventMetadata keys accepted for building an extended commit status ID? @makkes
There was a problem hiding this comment.
any suggestion how to proceed @makkes @stefanprodan ?
Signed-off-by: Brandt, Sebastian (ITO-PC) <sebastian.brandt@tchibo.de>
sebbrandt87
force-pushed
the
feat/gitlab-commit-status-event-label-usage
branch
from
9a7daac
to
fa99576
Compare
| @@ -1474,6 +1474,34 @@ spec: | |||
| name: flux-system | |||
| ``` | |||
|
|
|||
| ##### Construction of Git Commit Status ID | |||
There was a problem hiding this comment.
We should explain here what the commit status ID actually is and how it can be leveraged.
There was a problem hiding this comment.
Is it might be enough to link to GitHub and GitLab related API endpoints - as this documentation stays up2date? @makkes
GitHub: https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28
GitLab: https://docs.gitlab.com/ee/api/commits.html#set-the-pipeline-status-of-a-commit
Co-authored-by: Max Jonas Werner <makkes@users.noreply.github.com> Signed-off-by: Sebastian Brandt <sebbrandt@mailbox.org>
Co-authored-by: Max Jonas Werner <makkes@users.noreply.github.com> Signed-off-by: Sebastian Brandt <sebbrandt@mailbox.org>
Add a function to get a more detailed insight into the commit status of e.g. GitLab.
So that you do not need to lookup the first part of the Providers UIDs at all your Flux powered Kubernetes clusters.