Skip to content

chore(docs): add tagging strategy documentation for Terraform modules#385

Merged
virgofx merged 1 commit intomainfrom
docs(tagging)--add-tagging/release-architecture
Feb 18, 2026
Merged

chore(docs): add tagging strategy documentation for Terraform modules#385
virgofx merged 1 commit intomainfrom
docs(tagging)--add-tagging/release-architecture

Conversation

@virgofx
Copy link
Member

@virgofx virgofx commented Feb 18, 2026

This pull request introduces a new documentation file, tagging.md, which thoroughly explains the tagging and release strategy for Terraform modules within a monorepo. The document is intended to provide both human contributors and AI agents with a clear, detailed understanding of how the tagging, release, and cleanup processes work, as well as the rationale behind key design decisions.

Key additions in the documentation:

Tagging and Release Process Overview

  • Describes how each Terraform module receives a namespaced tag (e.g., aws/vpc/v1.2.0) and a corresponding GitHub Release, using tag-only commits that are not associated with any branch. Explains the reasoning for using orphaned commits and temporary directories to keep module releases isolated and efficient.

Configuration and Conventions

  • Details the tag naming convention, including customizable separators and version prefixes, and explains how tag-to-module matching is normalized to handle historical or configuration changes.
  • Documents how Terraform consumers should reference tags in their source blocks, including both HTTPS and SSH formats, and how the ref parameter can be set to either the tag or commit SHA for immutability.

Lifecycle and Cleanup

  • Outlines the process for identifying and deleting orphaned tags and releases when modules are removed from the monorepo, including the relevant methods and error handling strategies. (

Copilot AI review requested due to automatic review settings February 18, 2026 03:09
@virgofx virgofx force-pushed the docs(tagging)--add-tagging/release-architecture branch from 6d66682 to 67bd354 Compare February 18, 2026 03:12
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds comprehensive documentation about the tagging and release strategy for Terraform modules in a monorepo. The document is designed to provide both AI agents and human contributors with a detailed understanding of how the action creates, manages, and cleans up Git tags and GitHub Releases. The documentation covers tag naming conventions, the release creation flow, how Terraform consumers reference tags, lifecycle management, error handling, and design decisions with their rationales.

Changes:

  • Adds docs/tagging.md with detailed technical documentation covering the complete tagging and release lifecycle for Terraform modules

@virgofx virgofx force-pushed the docs(tagging)--add-tagging/release-architecture branch 2 times, most recently from 08a96be to 0e23b11 Compare February 18, 2026 03:17
@virgofx virgofx added the documentation Improvements or additions to documentation label Feb 18, 2026
@virgofx virgofx self-assigned this Feb 18, 2026
@virgofx virgofx requested a review from Copilot February 18, 2026 03:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

@virgofx virgofx force-pushed the docs(tagging)--add-tagging/release-architecture branch from 0e23b11 to 4d4495c Compare February 18, 2026 03:24
@github-actions
Copy link

📋 Release Plan

Module Type Latest
Version
New
Version
Release
Details
tf-modules-kms patch v1.0.0 🆕 Initial Release
tf-modules-vpc-endpoint patch v1.0.0 🆕 Initial Release

📝 Changelog

tf-modules-kms-v1.0.0 (2026-02-18)

  • 🔀PR #385 - chore(docs): add tagging strategy documentation for Terraform modules

tf-modules-vpc-endpoint-v1.0.0 (2026-02-18)

  • 🔀PR #385 - chore(docs): add tagging strategy documentation for Terraform modules

Wiki Statusℹ️

✅ Enabled

Automated Tag/Release Cleanupℹ️

⏸️ Existing tags and releases will be preserved as the delete-legacy-tags flag is disabled.

Powered by:   techpivot/terraform-module-releaser

@sonarqubecloud
Copy link

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@virgofx virgofx merged commit 8322a49 into main Feb 18, 2026
35 checks passed
@virgofx virgofx deleted the docs(tagging)--add-tagging/release-architecture branch February 18, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants