Skip to content

Prioritize release-please support for Terraform refactor patch releases #55

Description

@lgallard

Context

Terraform module source code is the distributed artifact. If a refactor: commit changes module .tf implementation, locals, defaults, validations, dynamic block emission, provider compatibility, or resource construction, users pinned to a Terraform Registry version or Git tag will not receive it unless release-please creates a new tag/release.

We hit this in terraform-aws-cognito-user-pool: a merged refactor: PR changed distributed module code, but release-please skipped with No user facing commits found, so pinned users would not receive the change.

Desired policy

Keep using honest Conventional Commit types, but make Terraform module implementation refactors publishable as patch releases instead of forcing maintainers to mislabel them as fix:.

Acceptance criteria

  • Inspect this repo's release-please setup.
  • If release-please is used, configure it so refactor: commits are included in changelog/release generation, normally as patch releases when no feat or breaking change is present.
  • Keep feat: and fix: behavior unchanged.
  • Do not make docs-only or CI-only changes release unless intentionally user-facing.
  • Document the policy in the PR summary so future refactor PRs use the right commit type.

Suggested release-please-config.json package setting:

"changelog-sections": [
  { "type": "feat", "section": "Features" },
  { "type": "fix", "section": "Bug Fixes" },
  { "type": "perf", "section": "Performance Improvements" },
  { "type": "refactor", "section": "Code Refactoring" }
]

Priority

High. Please treat this as the next repo maintenance issue before additional module refactor work, so pinned-version users receive future refactor changes through normal releases.

Metadata

Metadata

Assignees

Labels

priority: highHigh priority / next to addressrelease-pleaseRelease automation and release-pleaseterraform-moduleTerraform module maintenance

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions