Discrepancy in Default Behavior for keep_divergent_refs between GitLab and Terraform Provider
A customer has found that with the GitLab Terraform Provider, keep_divergent_refs
setting is true
, where our documentation states the default behavior is false
(overwrite differences).
GitLab Terraform Provider
In the Terraform Provider code, the default value for keep_divergent_refs
is set to true
"keep_divergent_refs": {
Description: "Determines if divergent refs are skipped.",
Type: schema.TypeBool,
Optional: true,
Default: true,
}
GitLab Documentation
By default, if any ref (branch or tag) on the remote (downstream) mirror diverges from the local repository, the upstream repository overwrites any changes on the remote
I am creating this issue to determine if this is intentional, and if it should be set similarly both ways, or if it should remain as is and be documented. In case of the latter, I have created a merge request for review, it may be a good idea to add this to our docs in the mean time.