The following section will document some of the best practices to releasing new versions of Beam. For more information on the process of publishing the Beam release, please see the Release Guide on the Beam website.


Rolling out breaking changes

If there is an upcoming change in API behavior that would break users' code, follow these steps

  1. Announcement
    1. Announce that there will be an upcoming change
    2. Add a warning log
    3. Add an option to opt-in to new API
  2. Make the new API the default
    1. Configure the API such that the new behavior is default.
    2. Keep a log and an option allow opting-out of the new API
  3. Deprecate the old API
    1. Remove the old API, and make the new API the only option.
    2. Remove all logs and flags
  • No labels