diff --git a/_docs-sources/patcher/running-patcher/update.md b/_docs-sources/patcher/running-patcher/update.md index 08bec44f63..b9a5e24b44 100644 --- a/_docs-sources/patcher/running-patcher/update.md +++ b/_docs-sources/patcher/running-patcher/update.md @@ -101,19 +101,42 @@ patcher update --non-interactive --skip-container-runtime --update-strategy next ## Support for Third Party Modules -Beginning with version `0.3.3`, Patcher provides limited support for updating third party modules, including your own modules. The updates to third party module are limited to bumping the semver patch version. +Patcher provides first class support for third party modules in both interactive mode and non-interactive mode, this includes your own modules. -Third party modules are supported in both interactive mode and non-interactive mode. +Starting in `0.4.3`, Patcher provides first class support for updating third party modules. The updates to third party modules are based on the semver version. -For example, the [terraform-aws-modules/terraform-aws-vpc](https://github.com/terraform-aws-modules/terraform-aws-vpc) module has two recent changes: `4.0.2` and `5.0.0`. +For example, the [terraform-aws-modules/terraform-aws-vpc](https://github.com/terraform-aws-modules/terraform-aws-vpc) module has three recent change: `5.0.0`, `5.1.0` and `5.1.1`. -And in `infrastructure-live/prod` there is a dependency on `terraform-aws-vpc/vpc`: -- `prod/us-east-1/prod/vpc/terragrunt.hcl` currently uses `4.0.0` +And in `infrastructure-live/dev` there is a dependency on `terraform-aws-vpc/vpc`: +- `dev/us-east-1/prod/dev/terragrunt.hcl` currently uses `4.0.0` -Patcher can update this dependency to `4.0.2` but because this only requires bumping the semver patch version. +![Screenshot of third party module dependency with updates available](/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png) + +Patcher can update this dependency to the latest version but because there is a breaking version in between, Patcher updates to `5.0.0` and writes a `README-TO-COMPLETE-UPDATE.md` file into the folder containing the dependendency. ![Screenshot of third party module dependency usages with updates available](/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png) -Patcher cannot update from `4.0.x` to `5.0.0` and will instead show a `?` in the "Up to date" column and the message "Patcher can not determine an update plan for this dependency". +The `README-TO-COMPLETE-UPDATE.md` file contains the [release note](https://github.com/terraform-aws-modules/terraform-aws-vpc/releases/tag/v5.0.0). + +```md +# vpc-endpoints v4.0.0 -> v5.0.0 (2023.08.15 13:39:56) + +Updated dependency vpc-endpoints in dev/us-east-1/dev/vpc/terragrunt.hcl to version v5.0.0, which contains breaking changes. You MUST follow the instructions in the release notes to complete this update safely: https://github.com/terraform-aws-modules/terraform-aws-vpc/releases/tag/v5.0.0 + +Here are the release notes for version v5.0.0: + +## [5.0.0](https://github.com/terraform-aws-modules/terraform-aws-vpc/compare/v4.0.2...v5.0.0) (2023-05-30) + + +### ⚠ BREAKING CHANGES + +* Bump Terraform AWS Provider version to 5.0 (#941) + +### Features + +* Bump Terraform AWS Provider version to 5.0 ([#941](https://github.com/terraform-aws-modules/terraform-aws-vpc/issues/941)) ([2517eb9](https://github.com/terraform-aws-modules/terraform-aws-vpc/commit/2517eb98a39500897feecd27178994055ee2eb5e)) +``` + +Running Patcher again will complete the update to `5.1.1`, the `README-TO-COMPLETE-UPDATE.md` file should be read, actioned and deleted first. -![Screenshot of third party module dependency that cannot be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-no-plan.png) +![Screenshot of third party module dependency full up to date](/img/guides/stay-up-to-date/patcher/patcher-report-overview-3p-futd.png) diff --git a/docs/patcher/running-patcher/update.md b/docs/patcher/running-patcher/update.md index 29a73e26b3..8df50c6859 100644 --- a/docs/patcher/running-patcher/update.md +++ b/docs/patcher/running-patcher/update.md @@ -101,27 +101,50 @@ patcher update --non-interactive --skip-container-runtime --update-strategy next ## Support for Third Party Modules -Beginning with version `0.3.3`, Patcher provides limited support for updating third party modules, including your own modules. The updates to third party module are limited to bumping the semver patch version. +Patcher provides first class support for third party modules in both interactive mode and non-interactive mode, this includes your own modules. -Third party modules are supported in both interactive mode and non-interactive mode. +Starting in `0.4.3`, Patcher provides first class support for updating third party modules. The updates to third party modules are based on the semver version. -For example, the [terraform-aws-modules/terraform-aws-vpc](https://github.com/terraform-aws-modules/terraform-aws-vpc) module has two recent changes: `4.0.2` and `5.0.0`. +For example, the [terraform-aws-modules/terraform-aws-vpc](https://github.com/terraform-aws-modules/terraform-aws-vpc) module has three recent change: `5.0.0`, `5.1.0` and `5.1.1`. -And in `infrastructure-live/prod` there is a dependency on `terraform-aws-vpc/vpc`: -- `prod/us-east-1/prod/vpc/terragrunt.hcl` currently uses `4.0.0` +And in `infrastructure-live/dev` there is a dependency on `terraform-aws-vpc/vpc`: +- `dev/us-east-1/prod/dev/terragrunt.hcl` currently uses `4.0.0` -Patcher can update this dependency to `4.0.2` but because this only requires bumping the semver patch version. +![Screenshot of third party module dependency with updates available](/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png) + +Patcher can update this dependency to the latest version but because there is a breaking version in between, Patcher updates to `5.0.0` and writes a `README-TO-COMPLETE-UPDATE.md` file into the folder containing the dependendency. ![Screenshot of third party module dependency usages with updates available](/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png) -Patcher cannot update from `4.0.x` to `5.0.0` and will instead show a `?` in the "Up to date" column and the message "Patcher can not determine an update plan for this dependency". +The `README-TO-COMPLETE-UPDATE.md` file contains the [release note](https://github.com/terraform-aws-modules/terraform-aws-vpc/releases/tag/v5.0.0). + +```md +# vpc-endpoints v4.0.0 -> v5.0.0 (2023.08.15 13:39:56) + +Updated dependency vpc-endpoints in dev/us-east-1/dev/vpc/terragrunt.hcl to version v5.0.0, which contains breaking changes. You MUST follow the instructions in the release notes to complete this update safely: https://github.com/terraform-aws-modules/terraform-aws-vpc/releases/tag/v5.0.0 + +Here are the release notes for version v5.0.0: + +## [5.0.0](https://github.com/terraform-aws-modules/terraform-aws-vpc/compare/v4.0.2...v5.0.0) (2023-05-30) + + +### ⚠ BREAKING CHANGES + +* Bump Terraform AWS Provider version to 5.0 (#941) + +### Features + +* Bump Terraform AWS Provider version to 5.0 ([#941](https://github.com/terraform-aws-modules/terraform-aws-vpc/issues/941)) ([2517eb9](https://github.com/terraform-aws-modules/terraform-aws-vpc/commit/2517eb98a39500897feecd27178994055ee2eb5e)) +``` + +Running Patcher again will complete the update to `5.1.1`, the `README-TO-COMPLETE-UPDATE.md` file should be read, actioned and deleted first. -![Screenshot of third party module dependency that cannot be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-no-plan.png) +![Screenshot of third party module dependency full up to date](/img/guides/stay-up-to-date/patcher/patcher-report-overview-3p-futd.png) diff --git a/static/img/guides/stay-up-to-date/patcher/patcher-report-overview-3p-futd.png b/static/img/guides/stay-up-to-date/patcher/patcher-report-overview-3p-futd.png new file mode 100644 index 0000000000..e8c2aaff40 Binary files /dev/null and b/static/img/guides/stay-up-to-date/patcher/patcher-report-overview-3p-futd.png differ diff --git a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-no-plan.png b/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-no-plan.png deleted file mode 100644 index 6af93ddc9a..0000000000 Binary files a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-no-plan.png and /dev/null differ diff --git a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png b/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png index c8bdf96edd..e1a205b976 100644 Binary files a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png and b/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-update-available.png differ diff --git a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-updated.png b/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-updated.png index 0ea75c020f..9bb4f89eac 100644 Binary files a/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-updated.png and b/static/img/guides/stay-up-to-date/patcher/patcher-update-overview-3p-updated.png differ diff --git a/static/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png b/static/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png index 298a1d9fee..34cceaeddf 100644 Binary files a/static/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png and b/static/img/guides/stay-up-to-date/patcher/patcher-update-usages-3p-update-available.png differ