docs icon indicating copy to clipboard operation
docs copied to clipboard

PagerDuty notifications are documented as an Anti-Pattern

Open bforte opened this issue 3 years ago • 0 comments

Reading through Sending Change Events from your pipeline it seems that I should be storing the Integration API Key in the pipeline. However, this is documented as an anti-pattern: Anti-pattern: Storing secrets in your pipeline.yml because that API key should be a secret.

Since this integration is tightly coupled to Buildkite, the documentation should be improved. These things are not clear:

  • Is pagerduty_change_event going to be redacted?
  • What is the recommended way of storing this secret in a static pipeline?

Moreover, I believe that there should be a warning somewhere in the documentation. Currently, people might just go ahead and store their secret in a pipeline (ref) because it seems like it is the official recommendation.

bforte avatar May 04 '22 09:05 bforte