From 473e12743f85720c9a6742dabc82a8616d12b6f0 Mon Sep 17 00:00:00 2001 From: Soren Martius Date: Tue, 23 Nov 2021 13:35:13 -0600 Subject: [PATCH] chore: prepare v0.11.0 release --- CHANGELOG.md | 37 +++++++++++++++++++++++++--- examples/public-repository/README.md | 2 +- examples/public-repository/main.tf | 2 +- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3268075..2b3420b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,13 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.11.0] + ### BREAKING CHANGES We dropped support for Terraform pre 1.0 and GitHub Terraform Provider pre 4.0. In addition we changed to the `integrations/github` official GitHub Terraform Provider. This needs migration actions if you already used this module with the `hashicorp/github` provider and want to upgrade. -Steps to upgrade will be added prior to the breaking release. +#### Migration from previous versions + +To migrate from a previous version, please ensure that you are using the +`integrations/github` official GitHub Terraform Provider. + + +``` hcl +terraform { + required_version = "~> 1.0" + + required_providers { + github = { + source = "integrations/github" + version = "~> 4.0" + } + } +} +``` + +Once you've updated the provider, a manual state migration is required to +migrate existing resources to the new provider. +The following command will replace the provider in the state. + +``` bash +terraform state replace-provider registry.terraform.io/hashicorp/github registry.terraform.io/integrations/github +``` + +After you've migrated the state, please run +`terraform init` to apply the changes to the resources. ### Added @@ -294,11 +324,12 @@ Please review plans and report regressions and issues asap so we can improve doc -[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.1...HEAD -[0.10.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.0...v0.10.1 +[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.11.0...HEAD +[0.11.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.1...v0.11.0 +[0.10.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.10.0...v0.10.1 [0.10.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.9.2...v0.10.0 [0.9.2]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.9.1...v0.9.2 [0.9.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.9.0...v0.9.1 diff --git a/examples/public-repository/README.md b/examples/public-repository/README.md index 46e9239..dea0fb1 100644 --- a/examples/public-repository/README.md +++ b/examples/public-repository/README.md @@ -15,7 +15,7 @@ branch protection. ```hcl module "repository" { source = "mineiros-io/repository/github" - version = "~> 0.10.0" + version = "~> 0.11.0" module_depends_on = [ github_team.team diff --git a/examples/public-repository/main.tf b/examples/public-repository/main.tf index d8c7d85..f08f8c0 100644 --- a/examples/public-repository/main.tf +++ b/examples/public-repository/main.tf @@ -7,7 +7,7 @@ module "repository" { source = "mineiros-io/repository/github" - version = "~> 0.10.0" + version = "~> 0.11.0" module_depends_on = [ github_team.team