sentry-cocoa icon indicating copy to clipboard operation
sentry-cocoa copied to clipboard

Ensure user facing options docs stay up-to-date

Open philipphofmann opened this issue 2 weeks ago • 2 comments

Description

This issue aims to implement an automated process that ensures that when adding a new Options option, that option is also added to the user-facing options doc.

One idea is to have a similar bot the danger.yml that fails when a PR doesn't include a proper changelog entry, but we can come up with any process that works for us.

Some edge cases to cover:

  • Ignore specific options with reason
  • The Cocoa SDK PR adding new options usually get merged before merging the docs PR, because we often only merge the docs PR after a Cocoa SDK release.

philipphofmann avatar Dec 09 '25 10:12 philipphofmann

COCOA-1078

linear[bot] avatar Dec 09 '25 10:12 linear[bot]

We might use a prompt as mentioned in https://github.com/getsentry/sentry-cocoa/issues/7014#issuecomment-3635920987 to automate this.

philipphofmann avatar Dec 10 '25 10:12 philipphofmann