Changelog
This is a BREAKING RELEASE.
Branch protection resources will be recreated and new features 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. Alternatively, all branch protections could be manually updated using
terraform state mv
but this is not recommended as it is a manual process that can suffer from human-prone errors. - If you do not want to archive repositories on deletion set
archive_on_destroy
to false in repository configurations.
Expected differences in a plan after upgrading:
- Addition to
module.<NAME>.github_repository.repository
:- Addition or changed default of argument
archive_on_destroy = true
- Addition or changed default of argument
- Destruction of
module.<NAME>.github_branch_protection.branch_protection[*]
- Creation of
module.<NAME>.github_branch_protection_v3.branch_protection[*]
- Replacement of
module.<NAME>.github_team_repository.team_repository_by_slug[<SLUG>]
- Triggered by change in
team_id = "<NUMBER>" -> "<SLUG>"
- Triggered by change in
Added
- Add support for Github Provider v4 (Minimal compatible version is v4.5).
- Add support for
archive_on_destroy
repository flag defaulting totrue
. - Add support for
vulnerability_alerts
repository flag. - 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
- Use
github_branch_protection_v3
instead ofgithub_branch_protection
for performance and compatibility reasons. ATTENTION: This Change will trigger recreation of all branch protections when upgrading to v0.8.0. - Use
github_branch_default
to set default branch of repositories. ATTENTION: This Change will trigger creation of new resource whendefault_branch
argument is set.
Removed
- BREAKING CHANGE: Removed support for Github Provider before v4.3