Skip to content

refactor: implement terraform module dependency parser and enhance type system #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jun 10, 2025
Merged

refactor: implement terraform module dependency parser and enhance type system #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
398413a
refactor: reorganize type system into dedicated files
virgofx Jun 9, 2025
21ac6bf
feat: add dedicated terraform module parser and enhance module class
virgofx Jun 9, 2025
7cc0f64
refactor: enhance core functionality and remove deprecated utilities
virgofx Jun 9, 2025
22832dc
test: comprehensive test suite updates and improvements
virgofx Jun 9, 2025
b841965
chore: update configuration and add development tooling
virgofx Jun 9, 2025
856c90e
refactor: enhance version tag handling and validation in TerraformModule
virgofx Jun 10, 2025
2d6e51c
refactor: optimize logging of parsed Terraform modules in parseTerraf…
virgofx Jun 10, 2025
7f22560
refactor: make _commits property readonly to prevent unintended modif…
virgofx Jun 10, 2025
a0aee7b
refactor: improve release and tag deletion comments for clarity and c…
virgofx Jun 10, 2025
206f07d
refactor: avoid mutating input by creating copies of tags and release…
virgofx Jun 10, 2025
63b2952
refactor: consolidate import statements for wiki-related constants
virgofx Jun 10, 2025
718fe6a
refactor: remove commented-out code for local dependency updates in g…
virgofx Jun 10, 2025
597ea5c
refactor: introduce MODULE_TAG_REGEX for improved tag parsing in Terr…
virgofx Jun 10, 2025
7fe7870
refactor: update output keys in CI workflow and README for consistenc…
virgofx Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/linters/.markdown-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ MD030:
MD033:
allowed_elements:
- sup
- sub
- br
- b
- p
- img
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
(to_entries[] |
"• \(.key):",
" - Path: \(.value.path)",
" - Current Tag: \(.value.currentTag)",
" - Latest Tag: \(.value.latestTag)",
" - Next Tag: \(.value.nextTag)",
" - Release Type: \(.value.releaseType)"
)
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ jobs:
VALIDATE_JAVASCRIPT_PRETTIER: false # Using biome
VALIDATE_JSON_PRETTIER: false # Using biome
VALIDATE_JSCPD: false # Using biome
VALIDATE_TERRAFORM_FMT: false # Terraform modules here aren't needed (They're for testing only)
VALIDATE_TERRAFORM_TFLINT: false # Terraform modules here aren't needed (They're for testing only)
VALIDATE_TYPESCRIPT_STANDARD: false # Using biome
VALIDATE_TYPESCRIPT_ES: false # Using biome
VALIDATE_TYPESCRIPT_PRETTIER: false # Using biome
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Dependency directory
node_modules

# Terraform
.terraform

# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
# Logs
logs
Expand Down
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,21 +184,21 @@ resources.
While the out-of-the-box defaults are suitable for most use cases, you can further customize the action's behavior by
configuring the following optional input parameters as needed.

| Input | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `major-keywords` | Keywords in commit messages that indicate a major release | `major change,breaking change` |
| `minor-keywords` | Keywords in commit messages that indicate a minor release | `feat,feature` |
| `patch-keywords` | Keywords in commit messages that indicate a patch release | `fix,chore,docs` |
| `default-first-tag` | Specifies the default tag version | `v1.0.0` |
| `terraform-docs-version` | Specifies the terraform-docs version used to generate documentation for the wiki | `v0.19.0` |
| `delete-legacy-tags` | Specifies a boolean that determines whether tags and releases from Terraform modules that have been deleted should be automatically removed | `true` |
| `disable-wiki` | Whether to disable wiki generation for Terraform modules | `false` |
| `wiki-sidebar-changelog-max` | An integer that specifies how many changelog entries are displayed in the sidebar per module | `5` |
| `disable-branding` | Controls whether a small branding link to the action's repository is added to PR comments. Recommended to leave enabled to support OSS. | `false` |
| `module-path-ignore` | A comma-separated list of module paths to completely ignore during processing. Paths matching these patterns will not be considered for versioning, releases, or documentation generation. | `` (empty string) |
| `module-change-exclude-patterns` | A comma-separated list of file patterns to exclude from triggering version changes in Terraform modules. Patterns follow glob syntax (e.g., `.gitignore,_.md`) and are relative to each Terraform module directory. Files matching these patterns will not affect version changes. **WARNING**: Avoid excluding '`_.tf`' files, as they are essential for module detection and versioning processes. | `.gitignore,*.md,*.tftest.hcl,tests/**` |
| `module-asset-exclude-patterns` | A comma-separated list of file patterns to exclude when bundling a Terraform module for tag/release. Patterns follow glob syntax (e.g., `tests/\*\*`) and are relative to each Terraform module directory. Files matching these patterns will be excluded from the bundled output. | `.gitignore,*.md,*.tftest.hcl,tests/**` |
| `use-ssh-source-format` | If enabled, all links to source code in generated Wiki documentation will use SSH standard format (e.g., `git::ssh://git@github.com/owner/repo.git`) instead of HTTPS format (`git::https://github.com/owner/repo.git`) | `false` |
| Input | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `major-keywords` | Keywords in commit messages that indicate a major release | `major change,breaking change` |
| `minor-keywords` | Keywords in commit messages that indicate a minor release | `feat,feature` |
| `patch-keywords` | Keywords in commit messages that indicate a patch release | `fix,chore,docs` |
| `default-first-tag` | Specifies the default tag version | `v1.0.0` |
| `terraform-docs-version` | Specifies the terraform-docs version used to generate documentation for the wiki | `v0.19.0` |
| `delete-legacy-tags` | Specifies a boolean that determines whether tags and releases from Terraform modules that have been deleted should be automatically removed | `true` |
| `disable-wiki` | Whether to disable wiki generation for Terraform modules | `false` |
| `wiki-sidebar-changelog-max` | An integer that specifies how many changelog entries are displayed in the sidebar per module | `5` |
| `disable-branding` | Controls whether a small branding link to the action's repository is added to PR comments. Recommended to leave enabled to support OSS. | `false` |
| `module-path-ignore` | Comma-separated list of module paths to completely ignore. Modules matching any pattern here are excluded from all versioning, releases, and documentation.<br><sub>[Read more here](#understanding-the-filtering-options)</sub> | `` (empty string) |
| `module-change-exclude-patterns` | Comma-separated list of file patterns (relative to each module) to exclude from triggering version changes. Lets you release a module but control which files inside it do not force a version bump.<br><sub>[Read more here](#understanding-the-filtering-options)</sub> | `.gitignore,*.md,*.tftest.hcl,tests/**` |
| `module-asset-exclude-patterns` | A comma-separated list of file patterns to exclude when bundling a Terraform module for tag/release. Patterns follow glob syntax (e.g., `tests/\*\*`) and are relative to each Terraform module directory. Files matching these patterns will be excluded from the bundled output. | `.gitignore,*.md,*.tftest.hcl,tests/**` |
| `use-ssh-source-format` | If enabled, all links to source code in generated Wiki documentation will use SSH standard format (e.g., `git::ssh://git@github.com/owner/repo.git`) instead of HTTPS format (`git::https://github.com/owner/repo.git`) | `false` |

### Understanding the filtering options

Expand Down Expand Up @@ -339,8 +339,8 @@ The following outputs are available from this action:
"changed-modules-map": {
"aws/vpc": {
"path": "modules/aws/vpc",
"currentTag": "aws/vpc/v1.0.0",
"nextTag": "aws/vpc/v1.1.0",
"latestTag": "aws/vpc/v1.0.0",
"releaseTag": "aws/vpc/v1.1.0",
"releaseType": "minor"
}
},
Expand Down
Loading