Conversation
6d66682 to
67bd354
Compare
There was a problem hiding this comment.
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.mdwith detailed technical documentation covering the complete tagging and release lifecycle for Terraform modules
08a96be to
0e23b11
Compare
0e23b11 to
4d4495c
Compare
📋 Release Plan
📝 Changelog
|
|



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
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
sourceblocks, including both HTTPS and SSH formats, and how therefparameter can be set to either the tag or commit SHA for immutability.Lifecycle and Cleanup