Releases: techpivot/terraform-module-releaser
v1.4.2
1.4.2 (2025-02-26)
New Features ✨
- Added Outputs 🛠️: Introduced new outputs for changed modules in GitHub Actions to enhance automation capabilities. @virgofx (#151)
Bug Fixes 🐛
- Improved Changelog Format 🔗: Updated changelog formatting to hyperlink PR numbers and handle multiline commit messages better. @virgofx (#160)
- Streamlined Commit Messages ✂️: Refined commit message format to exclude PR body content for wiki commits, ensuring cleaner and more readable logs. @virgofx (#158)
Improvements 🛠
- Dependency Updates 🔄: Several dependencies have been updated to improve performance and stability:
- Bumped SonarSource/sonarqube-scan-action from 4 to 5. @dependabot[bot] (#166)
- Updated multiple components within npm-production and npm-development groups to their newer patch versions. This includes updates to @octokit/core, @octokit/plugin-paginate-rest, @octokit/endpoint, @octokit/request, @octokit/plugin-rest-endpoint-methods, and others. @dependabot[bot] (#175, #174, #161, #152)
Full Changelog: v1.4.1...v1.4.2
v1.4.1
1.4.1 (2025-02-10)
Bug Fixes 🐛
- Sanitize Module Names 🧹: Enhanced security and stability by sanitizing the module names used during temporary directory creation, preventing issues with invalid characters. @virgofx (#155)
Improvements 🛠
- Ensured JSON Formatting 📁: Integrated a new formatting step in our CI process to ensure that
package.json
is consistently formatted correctly after any version updates. @virgofx (#150)
Full Changelog: v1.4.0...v1.4.1
v1.4.0
1.4.0 (2025-02-08)
Important: Version 1.4.0 contains a known issue. To avoid this issue:
- If you pin to specific versions: Use v1.4.1 or higher
- If you use the major version tag (v1): No action needed - you're already protected
New Features ✨
- SSH Source Format Option 🌐: Introduced a new configuration option
useSSHSourceFormat
to customize source URL formatting in Wikis. @virgofx (#146)
Bug Fixes 🐛
- Testing Stability Enhancements 🧪: Comments out a binary removal in tests to prevent asynchronous test error occurrences. @virgofx (#148)
- Cleaner Test Logs 🔧: Removed unnecessary console log debug calls during test executions, ensuring cleaner and more focused test outputs. @virgofx (#119)
- Refactor Mock Structure 🗂️: Moved configuration and context mocks into
__mocks__
directory for clearer, more standardized organization without affecting functionality. @virgofx (#118)
Improvements 🛠
- Dependency and Test Enhancements 📦: Updated several dependencies including @types/node and vitest; improved test coverage across multiple components including terraform modules, pull requests, and changelog functionalities; added detailed tests specific to new features. @virgofx #115; #113; #112; #110; #109; @dependabot[bot] (#145; #141; #138; #135; #133; #121; #123)
Additional Changes 🚨
- SonarCloud GitHub Actions Update 🔄: Upgraded
sonarsource/sonarcloud-github-action
from version 3 to 4. @dependabot[bot] (#120)
Full Changelog: v1.3.1...v1.4.0
v1.3.1
1.3.1 (2024-10-31)
New Features ✨
-
Terraform Tests Added 📜: Introducing new tests dedicated to terraform-docs, enhancing our documentation and support for Windows systems. @virgofx (#106)
-
Semver Tests In Place 🧪: We've expanded our test coverage to include semantic versioning, ensuring more reliable version management. @virgofx (#105)
-
Additional Context Tests 🔄: Enhanced testing frameworks like Vitest now support our context functionalities, improving our testing performance and integration. @virgofx (#102)
-
Strengthened Constants Testing ⚙️: Tests have now been added for
constants
, increasing the robustness of our configuration management. @virgofx (#101) -
File Utility Testing 🗂️: Comprehensive tests for file-util.ts have been incorporated, solidifying our file operations management. @virgofx (#100)
-
Enhanced CI Testing with Vitest 🔍: Implementation of first Jest (and now Vitest) for automated CI testing, coupled with a revised CI workflow, uplifts our project's testing architecture. @virgofx (#98)
Bug Fixes 🐛
-
Terraform Docs Generation Fix 🛠: Fixed a bug to prevent the misuse of terraform-docs config during documentation generation. Fixes associated usability issues. @virgofx (#104)
-
Readme Link Correction 🔗: Updated the quality gate status link to point to the correct reference, ensuring accuracy in our project reporting. @virgofx (#99)
Improvements 🛠
-
Dependency Upgrade: Minimatch 📦: Upgraded Minimatch from 9.0.5 to 10.0.1 to leverage newer functionalities and improvements (#97)
-
Development Dependency Update 🌐: Updated the @types/node package within the npm-development group to enhance compatibility and developer experience (#96)
Full Changelog: v1.3.0...v1.3.1
v1.3.0
1.3.0 (2024-10-27)
New Features ✨
-
Enhanced Wiki Generation 📚: Improved the wiki content generation process, ensuring a more secure and clean directory structure. @virgofx (#90)
- Introduced additional constants to correctly display characters in wiki titles.
- Refined the functions for generating and pushing wiki content.
-
Asset & Exclude Pattern Filtering 🔍: Added configuration options to control the inclusion of certain files in module releases, improving flexibility and preventing unnecessary deployments. @virgofx (#81)
Bug Fixes 🐛
-
Security Enhanced Path Usage 🛡: Ensured paths are fully qualified to prevent potential shell injections, adding an additional layer of security to file operations. @virgofx (#93)
-
Regex Backtracking Prevention 🚫: Addressed multiple security fixes related to regex operations which could potentially lead to Denial of Service (DoS).
- Fixed issues with sidebar generation regex in wiki which prevented regex backtracking vulnerabilities. @virgofx (#92)
- Adjusted character class usage in regex to prevent potential security vulnerabilities. @virgofx (#87)
- Modified regex patterns to remove unnecessary escape characters and to prevent potential DoS backtrack issues. @virgofx (#86, #89)
-
Code Cleanups and Optimizations 🧹: Removed debug code and unnecessary variables to streamline operations. @virgofx (#91, #88)
Full Changelog: v1.2.0...v1.3.0
v1.2.0
1.2.0 (2024-10-24)
New Features ✨
- Enhanced Email Retrieval for GitHub Username: Streamlined email processing within changelog.js, pairing it with GitHub username retrieval. @virgofx (#70)
Bug Fixes 🐛
- Changelog Commit Retrieval Fixed: Addressed an issue in changelog.js that prevented correct commit fetching during release preparation. @virgofx (#53)
- Retry Logic for Username Fetching: Added retry mechanisms for robust email-based username fetching and improved backend dispatching functionality. @virgofx (#69)
- Disable Release Commit Sign-off: Removed obligatory sign-off for release commits and ensured distribution checks are executed properly. @virgofx (#77)
Improvements 🛠
- Enhanced Release Automation: Implemented a new GitHub Actions workflow to handle releases with proper versioning and branch management, accelerating the release cycle and maintaining semantic standards. @virgofx (#29)
Full Changelog: v1.1.1...v1.2.0
v1.1.1
v1.1.0
What's Changed
Enhancements:
- Prevent re-runs of the release workflow on merged pull requests (#20).
- Improved GitHub API interactions and error handling (#19).
- Added functionality to dynamically obtain and include the Wiki link in the release process.
Bug Fixes:
- Resolve issue with tracking changes in Terraform modules when multiple commits cancel each other out. Only effective file changes are now tracked (#22).
- Fixed the output issue preventing the release plan summary from displaying correctly for initial releases.
- Corrected the indentation in the Wiki sidebar output for proper XHTML formatting.
UI and Documentation Improvements:
- Enhanced the post-release summary with clickable Wiki links and improved UI elements.
- Updated docblocks for clarity and maintainability.
- Updated
README.md
to reflect new changes and remove references to custom PATs. - Clarified
SECURITY.md
with details on using the defaultGITHUB_TOKEN
for scoped access and simplified token management.
Versioning and Packaging:
- Prepared assets for the v1.1.0 release, including proper packaging and versioning.
Full Changelog:
v1.0.1 - Bug Fixes for Wiki Checkout and Doc Updates
What's Changed
- Fixed wiki generation failures due to incorrect checkout and authentication logic (#6)
- Revised wiki checkout logic to mimic @actions/checkout flow for improved reliability
- Tested and validated fixes on previously failing repositories
- Improved error handling and diagnostics for wiki checkout and PR comment wiki status
- Updated documentation and README to reflect changes and improvements
Full Changelog:
🚀 v1.0.0 - Initial Release of Terraform Module Releaser
We are excited to announce the first stable release of Terraform Module Releaser! This GitHub Action simplifies the management of Terraform modules within monorepos by automating versioning, tagging, releases, and documentation generation.
🎯 Key Features:
-
Automated Versioning & Tagging:
- Detects module-specific changes and calculates the appropriate SemVer version.
- Automatically tags and pushes new versions for each module independently.
-
Release Management:
- Determines the release type (major, minor, or patch) based on commit messages following the Conventional Commits specification.
- Generates release notes with detailed descriptions of changes for
-
Wiki Integration:
- Automatically updates the GitHub Wiki with:
- Module-specific README content.
- terraform-docs generated usage information.
- Full changelogs for each module.
- Automatically updates the GitHub Wiki with:
-
Efficient Tagging:
- Tags only the relevant modules affected by changes, improving repository management and Terraform performance.
-
Commit-based Change Detection:
- Removes the complexity of label-based systems by leveraging commit messages for precision in release management.
-
Module Cleanup:
- Automatically removes tags for deleted modules to keep your repository clean and organized.