Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.16 KB

File metadata and controls

25 lines (17 loc) · 1.16 KB

Atlas SDK update

Most of the new features of the provider are using atlas-sdk SDK is updated automatically, tracking all new Atlas features.

How to update Atlas SDK

To update Atlas SDK run:

make update-atlas-sdk

NOTE: The update mechanism is only needed for major releases. Any other releases will be supported by dependabot.

NOTE: Command can make import changes to +500 files. Please make sure that you perform update on main branch without any uncommited changes.

SDK Major Release Update Procedure

  1. If the SDK update doesn’t cause any compilation issues create a new SDK update PR
    1. Review API Changelog for any deprecated fields and breaking changes.
  2. For SDK updates introducing compilation issues without graceful workaround
    1. Use the previous major version of the SDK (including the old client) for the affected resource
    2. Create an issue to identify the root cause and mitigation paths based on changelog information
    3. If applicable: Make required notice/update to the end users based on the plan.