You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.5 KiB

Raw Blame History

RFC-xxxx Create a new API kind for Commit Status

Status: provisional

Creation date: 2022-05-12

Last update: 2022-05-12

Summary

There should be a dedicated kind in the notification controller for sending commit status notifications to git providers.

Motivation

Currently, The Alert type can reference both git providers and chat providers. However, the differences between the two providers and how notifications being sent to them should be handled has continued to diverge. For example, there is a limit on the status message for git provider and sending the same notification twice overwrites the first one.

By creating a sepeerate kind for git commit status, the specific nuances of the provider can be properly taken into account.

Goals

Add a new kind CommitStatus to Flux notification controller for handling commit status notifications.

Non-Goals

Add new spec fields to the Alert kind.

Proposal

Introduce a new kind in the notification-controller called CommitStatus. The CommitStatus kind will similar to the Alert kind, referencing a provider and including event sources to accept events from. The major difference is that it will only reference git providers. Additionally, it can only have a Kustomization as its event source since it requires the revision field in the event metadata.

This proposal will also introduce breaking changes as the Alert kind will no longer send notifications to git providers.

User Stories

If a user want to receive status notification on github for a deployment, a CommitStatus kind can be used:

apiVersion: notification.toolkit.fluxcd.io/v1beta1
kind: CommitStatus
metadata:
  name: webapp
  namespace: flux-system
spec:
  providerRef: 
    name: github # The `spec.type` of the provider has to be github, gitlab, or bitbucket
  eventSeverity: info
  eventSources:
    - kind: Kustomization
      name: webapp

Alternatives

Alternatively, we could keep using the Alert kind for sending notifications to git providers. While this might not be much of a pain now, it would continue to grow as the implementations details of new features might differ for the chat and git providers.

2.5 KiB Raw Blame History