BREAKING CHANGE: Remove mandatory Environment tag from all Terraform modules#75
Conversation
Co-authored-by: fredleger <2778741+fredleger@users.noreply.github.com>
|
@copilot since this is quite important i would like to be sure we have a significant version bump here (given that we use semver and conventional commit conventions) |
I've updated the commit message to follow conventional commit format with
The commit message now follows proper semver conventions for this breaking change. Commit: 85644b6 |
@copilot you mean the PR title that will lead to the commit message title once merged right ? |
Exactly! The PR title "BREAKING CHANGE: Remove mandatory Environment tag from all Terraform modules" will become the commit message title when this PR is merged (via squash merge). That's what your release-drafter will use to determine the version bump - the PR title triggers the major version bump, not the individual commits in the branch. |
|
@copilot usualy i have a pre-commit hook that update the documentation of each module using tfdocs. Can you run it before merging the PR ? The hooks can also be enforced by the PR it's fine to me |
I attempted to run the pre-commit hooks to update the documentation, but terraform and terraform-docs are not available in this environment. The README files currently still reference the removed The terraform_docs hook will need to be run either:
The documentation update is necessary since all modules no longer accept the Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Problem
Experience has proven that mandatory Environment tags can lead to inconsistencies, particularly when mixing low-level environment tags with application-level environment tags in monitoring systems like Datadog. The current implementation forces all modules to include an Environment tag, preventing users from making conscious decisions about environment tagging strategies.
This is a major version change that removes the mandatory Environment tag from all Terraform modules. The commit follows conventional commit format (
BREAKING CHANGE:) to ensure proper semantic versioning with a major version bump.Solution
This PR removes the mandatory Environment tag from all Terraform modules while normalizing the tag structure across the entire repository. The changes ensure that:
tagsvariable when neededChanges Made
BREAKING CHANGE:prefixBefore
After
Breaking Changes
This change is breaking because:
environmentvariable is removed from all modulestagsvariableMigration Guide
Users who want environment tags should now add them explicitly:
Documentation Update Required
Note: The module README files (49 files) still contain references to the removed
environmentvariable in their auto-generated documentation. These will need to be updated by running theterraform_docspre-commit hook either locally, via CI/CD pipeline, or automatically after merge.Semantic Versioning
The commit message uses
BREAKING CHANGE:prefix which will trigger a major version bump (e.g., 1.11.1 → 2.0.0) when using the release-drafter configuration, ensuring proper semantic versioning for this breaking change.This change promotes better tagging practices by making environment tagging a conscious decision rather than an automatic inclusion that can lead to inconsistencies.
Fixes #74
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.