Skip to content

Commit

Permalink
release: prepare 0.8.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mariux committed May 23, 2021
1 parent 3c508a4 commit 8c883ab
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 7 deletions.
22 changes: 19 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [0.8.0]

**_This is a BREAKING RELEASE._**

Branch protection resourcess will be recreated and new fetures are added enforcing security by default.

Please review plans and report regressions and issues asap so we can improve documentation for upgrading.

### Upgrade path/notes:

- Branch protections will be recreated in a compatible way. Alternativly all branchprotections could be manually updated using `terraform state mv` but this is not recommended as it is a manual process that can suffer from human errors.
- If you want to opt-out of vulnerability alerts, set `vulnerability_alerts` to false in repository configurations.
- If you do not want to archive repositoires on deletion set `archive_on_destroy` to false in repository configurations.

### Added

- Add support for Github Provider v4 (Minimal compatible version is v4.3).
- Add support for Github Provider v4 (Minimal compatible version is v4.5).
- Add support for `archive_on_destroy` repository flag defaulting to `true`.
- Add support for `vulnerability_alerts` repository flag defaulting to `true`.
- Add security deny list for v4.7.0, v4.8.0, v4.9.0 and v4.9.1 due to a bug setting visibility to public for templated repository creation.

### Changed

Expand Down Expand Up @@ -215,11 +230,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

<!-- markdown-link-check-disable -->

[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.6.1...v0.7.0
[unreleased]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.8.0...HEAD
[0.8.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.7.0...v0.8.0

<!-- markdown-link-check-enable -->

[0.7.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.6.1...v0.7.0
[0.6.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.6.0...v0.6.1
[0.6.0]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.5.1...v0.6.0
[0.5.1]: https://github.com/mineiros-io/terraform-github-repository/compare/v0.5.0...v0.5.1
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ _This module supports Terraform v0.14, v0.13 as well as v0.12.9 and above and is

_The latest version being compatible with the Terraform Github Provider v3 as well as v2 was v0.7.0 of this module._

_Security related notice: Versions 4.7.0, 4.8.0, 4.9.0 and 4.9.1 of the Terraform Github Provider are deny-listed in version constrains as a regression introduced in 4.7.0 and fixed in 4.9.2 creates public repositories from templates even if visibility is set to private._

- [Module Features](#module-features)
- [Getting Started](#getting-started)
- [Module Argument Reference](#module-argument-reference)
Expand Down Expand Up @@ -88,7 +90,7 @@ Most basic usage creating a new private github repository.
```hcl
module "repository" {
source = "mineiros-io/repository/github"
version = "~> 0.6.0"
version = "~> 0.8.0"
name = "terraform-github-repository"
license_template = "apache-2.0"
Expand Down Expand Up @@ -158,7 +160,7 @@ See [variables.tf] and [examples/] for details and use-cases.

- ~`private`~: _(Optional `bool`)_

DEPRICATED. Please use `visibility` instead and update your code. parameter will be removed in a future version
**_DEPRECATED_**: Please use `visibility` instead and update your code. parameter will be removed in a future version

- **`visibility`**: _(Optional `string`)_

Expand Down Expand Up @@ -220,6 +222,15 @@ See [variables.tf] and [examples/] for details and use-cases.
should be extended with more topics.
Default is `[]`.

- **`vulnerability_alerts`**: _(Optional `bool`)_

Set to `false` to disable security alerts for vulnerable dependencies.
Enabling requires alerts to be enabled on the owner level.

- **`archive_on_destroy`**: _(Optional `bool`)_

Set to `false` to not archive the repository instead of deleting on destroy.

#### Repository Creation Configuration

The following four arguments can only be set at repository creation and
Expand Down Expand Up @@ -757,7 +768,7 @@ Copyright &copy; 2020 [Mineiros GmbH][homepage]
[badge-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg
[badge-terraform]: https://img.shields.io/badge/terraform-0.14%20|%200.13%20|%200.12.20+-623CE4.svg?logo=terraform
[badge-slack]: https://img.shields.io/badge/slack-@mineiros--community-f32752.svg?logo=slack
[badge-tf-gh]: https://img.shields.io/badge/GH-3%20and%202.6+-F8991D.svg?logo=terraform
[badge-tf-gh]: https://img.shields.io/badge/GH-4-F8991D.svg?logo=terraform
[releases-github-provider]: https://github.com/terraform-providers/terraform-provider-github/releases
[build-status]: https://github.com/mineiros-io/terraform-github-repository/actions
[releases-github]: https://github.com/mineiros-io/terraform-github-repository/releases
Expand Down
2 changes: 1 addition & 1 deletion examples/public-repository/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ branch protection.
```hcl
module "repository" {
source = "mineiros-io/repository/github"
version = "~> 0.7.0"
version = "~> 0.8.0"
module_depends_on = [
github_team.team
Expand Down

0 comments on commit 8c883ab

Please sign in to comment.