chore: prepare 0.18.0 release

mineiros-io · Nov 6, 2022 · 6d601b1 · 6d601b1
1 parent 6e5763c
commit 6d601b1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.18.0]
+
+### Added
+
+- Add support for v4 branch protections.
+
+### Removed
+
+- BREAKING CHANGE: Remove deprectated variable `branch_protections` please use `branch_protections_v3` instead.
+
 ## [0.17.0]
 
 ### Added
@@ -385,7 +395,8 @@ Please review plans and report regressions and issues asap so we can improve doc
 - This is the initial release of our GitHub Repository module with support for
   creating and managing GitHub Repositories for Organizations.
 
-[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.17.0...HEAD
+[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.18.0...HEAD
+[0.18.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.17.0...v0.18.0
 [0.17.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.2...v0.17.0
 [0.16.2]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.1...v0.16.2
 [0.16.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.16.0...v0.16.1

diff --git a/README.md b/README.md
@@ -104,25 +104,12 @@ Most basic usage creating a new private github repository.
 ```hcl
 module "repository" {
   source  = "mineiros-io/repository/github"
-  version = "~> 0.16.0"
+  version = "~> 0.18.0"
 
   name               = "terraform-github-repository"
   license_template   = "apache-2.0"
   gitignore_template = "Terraform"
 }
-
-provider "github" {}
-
-terraform {
-  required_version = "~> 1.0"
-
-  required_providers {
-    github = {
-      source  = "integrations/github"
-      version = "~> 4.0"
-    }
-  }
-}
 ```
 
 ## Module Argument Reference

diff --git a/README.tfdoc.hcl b/README.tfdoc.hcl
@@ -109,25 +109,12 @@ section {
       ```hcl
       module "repository" {
         source  = "mineiros-io/repository/github"
-        version = "~> 0.16.0"
+        version = "~> 0.18.0"
 
         name               = "terraform-github-repository"
         license_template   = "apache-2.0"
         gitignore_template = "Terraform"
       }
-
-      provider "github" {}
-
-      terraform {
-        required_version = "~> 1.0"
-
-        required_providers {
-          github = {
-            source  = "integrations/github"
-            version = "~> 4.0"
-          }
-        }
-      }
       ```
     END
   }