File tree Expand file tree Collapse file tree 1 file changed +11
-1
lines changed Expand file tree Collapse file tree 1 file changed +11
-1
lines changed Original file line number Diff line number Diff line change @@ -291,6 +291,7 @@ Examples:
291
291
Most of the new features of the provider are using [ atlas-sdk] ( https://github.com/mongodb/atlas-sdk-go )
292
292
SDK is updated automatically, tracking all new Atlas features.
293
293
294
+
294
295
### Updating Atlas SDK
295
296
296
297
To update Atlas SDK run:
@@ -299,6 +300,15 @@ To update Atlas SDK run:
299
300
make update-atlas-sdk
300
301
```
301
302
302
- > NOTE: Update mechanism is only needed for major releases. Any other releases will be supported by dependabot.
303
+ > NOTE: The update mechanism is only needed for major releases. Any other releases will be supported by dependabot.
303
304
304
305
> NOTE: Command can make import changes to +500 files. Please make sure that you perform update on main branch without any uncommited changes.
306
+
307
+ ### SDK Major Release Update Procedure
308
+
309
+ 1 . If the SDK update doesn’t cause any compilation issues create a new SDK update PR
310
+ 1 . Review [ API Changelog] ( https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog ) for any deprecated fields and breaking changes.
311
+ 2 . For SDK updates introducing compilation issues without graceful workaround
312
+ 1 . Use the previous major version of the SDK (including the old client) for the affected resource
313
+ 1 . Create an issue to identify the root cause and mitigation paths based on changelog information
314
+ 2 . If applicable: Make required notice/update to the end users based on the plan.
You can’t perform that action at this time.
0 commit comments