Add support for tag-based environment deployment branch policy #2165
Conversation
The Type field is only necessary when creating a deployment branch policy. When updating a deployment branch policy, the Type field is not needed and is therefore set to nil. Resources: - https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28
…ry_environment_deployment_policy resource
…nt_policy" This reverts commit 88b1369.
…_policy resource" This reverts commit a534219.
…repository_environment_deployment_policy resource" This reverts commit 029960b.
This reverts commit af308a1.
|
Tests are all passing for me. The chosen
It doesn't seem to me like a new resource in Terraform is created here; the same One other reasonable option might be to create a new resource, something like |
The update endpoint for deployment branch policies does not support changing from a branch pattern to a tag pattern or vice versa; it only supports pattern changes within the pattern type that was chosen at creation time. So if terraform config changes like this: resource "github_repository_environment_deployment_policy" "test" {
repository = github_repository.test.name
environment = github_repository_environment.test.environment
- branch_pattern = "release/*"
+ tag_pattern = "release/*"
}then this plugin marks the resource with the These two tests: (1, 2) were designed to ensure that a new resource is created by comparing the unique ids of the created and updated policies. This is in contrast to these two tests (1, 2) which confirm the policy id does not change when only the pattern changes. A simpler alternative is to always, overeagerly recreate environment deployment policies when their configuration changes.
GitHub only uses one term (deployment branch policy) for both branch-based and tag-based policies and I think there's some advantage in matching what they're doing. That said, I don't think the naming used for these resources is perfect. Right now we have both: |
|
Any update on this? |
|
bump |
Resolves #1974. Supersedes #2050.
Before the change?
github_repository_environment_deployment_policyonly supported branch-based policies even though the GitHub API has support for both branch-based and tag-based policies.After the change?
tag_patternattribute has been added to thegithub_repository_environment_deployment_policyresource.Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!
Because the update API does not support pattern type (only name), I attempted to make switching between
branch_patternandtag_patternrequire a new resource. Not entirely sure I did that or tested it well, so would appreciate particular attention on that aspect of this PR.