Skip to content

Commit 223566b

Browse files
authored
doc: Restructures & updates 2.0 guide (#3616)
1 parent a1b0bf0 commit 223566b

File tree

3 files changed

+22
-25
lines changed

3 files changed

+22
-25
lines changed

RELEASING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Before triggering a release, view the corresponding [unreleased jira page](https
1717

1818
While QA acceptance tests are run in the release process automatically, we check [workflows/test-suite.yml](https://github.com/mongodb/terraform-provider-mongodbatlas/actions/workflows/test-suite.yml) and see if the latest run of the Test Suite action is successful (it runs every day at midnight UTC time). This can help detect failures before proceeding with the next steps.
1919

20-
### Verify upgrade guide is defined
20+
### Verify upgrade guide is defined (if required)
2121

22-
**Note**: Only applies if the right most version digit is 0 (considered a major or minor version in [semantic versioning](https://semver.org/)).
22+
- A document (./docs/guides/X.0.0-upgrade-guide.md) must be provided for each major version, summarizing the most significant features, breaking changes, and other helpful information. For minor version releases, this can be created if there are notable changes that warrant it.
2323

24-
- A doc ./docs/guides/X.Y.0-upgrade-guide.md must be defined containing a summary of the most significant features, breaking changes, and additional information that can be helpful. If not defined the release process will be stopped automatically. The expectation is that this file is created during relevant pull requests (breaking changes, significant features), and not before the release process.
24+
- The expectation is that this file is created during relevant pull requests (breaking changes, significant features), and not before the release process.
2525

2626
- We keep [Guides](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/docs/guides) only for 12 months. Add header `subcategory: "Older Guides"` to previous versions.
2727

docs/guides/2.0.0-upgrade-guide.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,29 @@ The Terraform MongoDB Atlas Provider version 2.0.0 has the following new feature
2828

2929
## Breaking Changes
3030

31-
- `mongodbatlas_cloud_backup_schedule`
32-
- Resource:
33-
- `export` and `auto_export_enabled` are now optional only arguments. This facilitates tracking changes in their configurations.
31+
### `mongodbatlas_cloud_backup_schedule`
32+
Resource:
33+
- `export` and `auto_export_enabled` are now optional only arguments. This facilitates tracking changes in their configurations.
34+
- `copy_settings.#.replication_spec_id` attribute has been removed. Use `copy_settings.#.zone_id` instead. To learn more, see the [1.18.0 upgrade guide](../guides/1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).
3435

35-
- `mongodbatlas_cloud_backup_schedule`
36-
- Resource:
37-
- `copy_settings.#.replication_spec_id` attribute has been removed. Use `copy_settings.#.zone_id` instead. To learn more, see the [1.18.0 upgrade guide](../guides/1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).
36+
Data source:
37+
- `copy_settings.#.replication_spec_id` and `use_zone_id_for_copy_settings` attributes have been removed. Remove any usage of `use_zone_id_for_copy_settings` & replace any references to `copy_settings.#.replication_spec_id` in your configurations with `copy_settings.#.zone_id`. To learn more, see the [1.18.0 upgrade guide](../guides/1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).
3838

39-
- Data source:
40-
- `copy_settings.#.replication_spec_id` and `use_zone_id_for_copy_settings` attributes have been removed. Remove any usage of `use_zone_id_for_copy_settings` & replace any references to `copy_settings.#.replication_spec_id` in your configurations with `copy_settings.#.zone_id`. To learn more, see the [1.18.0 upgrade guide](../guides/1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).
4139

42-
43-
- `mongodbatlas_maintenance_window`
44-
- Resource:
45-
- `hour_of_day` is now required. This clarification prevents errors when creating new resources.
40+
### `mongodbatlas_maintenance_window`
41+
Resource:
42+
- `hour_of_day` is now required. This clarification prevents errors when creating new resources.
4643

47-
- `mongodbatlas_custom_db_role`
48-
- Resource:
49-
- `actions` now is set as `TypeSet`. This prevents plan diffs when reordering the `actions` in the resource.
44+
### `mongodbatlas_custom_db_role`
45+
Resource:
46+
- `actions` now is set as `TypeSet`. This prevents plan diffs when reordering the `actions` in the resource.
5047

51-
- `mongodbatlas_global_cluster_config`
52-
- Resource:
53-
- `custom_zone_mapping` attribute has been removed. Use `custom_zone_mapping_zone_id` instead. To learn more, see the [Sharding Configuration guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/advanced-cluster-new-sharding-schema).
48+
### `mongodbatlas_global_cluster_config`
49+
Resource:
50+
- `custom_zone_mapping` attribute has been removed. Use `custom_zone_mapping_zone_id` instead. To learn more, see the [Sharding Configuration guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/advanced-cluster-new-sharding-schema).
5451

55-
- Data source:
56-
- `custom_zone_mapping` attribute has been removed. Use `custom_zone_mapping_zone_id` instead. To learn more, see the [Sharding Configuration guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/advanced-cluster-new-sharding-schema).
52+
Data source:
53+
- `custom_zone_mapping` attribute has been removed. Use `custom_zone_mapping_zone_id` instead. To learn more, see the [Sharding Configuration guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/advanced-cluster-new-sharding-schema).
5754

5855

5956

scripts/check-upgrade-guide-exists.sh

100755100644
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ RELEASE_NUMBER=$(echo "${RELEASE_TAG}" | tr -d v)
88

99
IFS='.' read -r MAJOR MINOR PATCH <<< "$RELEASE_NUMBER"
1010

11-
# Check if it's a major release (patch version is 0)
12-
if [ "$PATCH" -eq 0 ]; then
11+
# Check if it's a major release (minor and patch versions are 0)
12+
if [ "$PATCH" -eq 0 ] && [ "$MINOR" -eq 0 ]; then
1313
UPGRADE_GUIDE_PATH="docs/guides/$MAJOR.$MINOR.$PATCH-upgrade-guide.md"
1414
echo "Checking for the presence of $UPGRADE_GUIDE_PATH"
1515
if [ ! -f "$UPGRADE_GUIDE_PATH" ]; then

0 commit comments

Comments
 (0)