Skip to content

Commit 7fe7870

Browse files
virgofxvirgofx
committed
refactor: update output keys in CI workflow and README for consistency; enhance action output handling in main.ts
1 parent 597ea5c commit 7fe7870

File tree

7 files changed

+232
-77
lines changed

7 files changed

+232
-77
lines changed

‎.github/linters/.markdown-lint.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ MD030:
2121
MD033:
2222
allowed_elements:
2323
- sup
24+
- sub
25+
- br
2426
- b
2527
- p
2628
- img

‎.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ jobs:
8080
(to_entries[] |
8181
"• \(.key):",
8282
" - Path: \(.value.path)",
83-
" - Current Tag: \(.value.currentTag)",
83+
" - Latest Tag: \(.value.latestTag)",
8484
" - Next Tag: \(.value.nextTag)",
8585
" - Release Type: \(.value.releaseType)"
8686
)

‎.github/workflows/lint.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ jobs:
5454
VALIDATE_JAVASCRIPT_PRETTIER: false # Using biome
5555
VALIDATE_JSON_PRETTIER: false # Using biome
5656
VALIDATE_JSCPD: false # Using biome
57+
VALIDATE_TERRAFORM_FMT: false # Terraform modules here aren't needed (They're for testing only)
58+
VALIDATE_TERRAFORM_TFLINT: false # Terraform modules here aren't needed (They're for testing only)
5759
VALIDATE_TYPESCRIPT_STANDARD: false # Using biome
5860
VALIDATE_TYPESCRIPT_ES: false # Using biome
5961
VALIDATE_TYPESCRIPT_PRETTIER: false # Using biome

‎README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -184,21 +184,21 @@ resources.
184184
While the out-of-the-box defaults are suitable for most use cases, you can further customize the action's behavior by
185185
configuring the following optional input parameters as needed.
186186

187-
| Input | Description | Default |
188-
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
189-
| `major-keywords` | Keywords in commit messages that indicate a major release | `major change,breaking change` |
190-
| `minor-keywords` | Keywords in commit messages that indicate a minor release | `feat,feature` |
191-
| `patch-keywords` | Keywords in commit messages that indicate a patch release | `fix,chore,docs` |
192-
| `default-first-tag` | Specifies the default tag version | `v1.0.0` |
193-
| `terraform-docs-version` | Specifies the terraform-docs version used to generate documentation for the wiki | `v0.19.0` |
194-
| `delete-legacy-tags` | Specifies a boolean that determines whether tags and releases from Terraform modules that have been deleted should be automatically removed | `true` |
195-
| `disable-wiki` | Whether to disable wiki generation for Terraform modules | `false` |
196-
| `wiki-sidebar-changelog-max` | An integer that specifies how many changelog entries are displayed in the sidebar per module | `5` |
197-
| `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` |
198-
| `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. <sub>[Read more here](#understanding-the-filtering-options)</sub> | `` (empty string) |
199-
| `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. <sub>[Read more here](#understanding-the-filtering-options)</sub> | `.gitignore,*.md,*.tftest.hcl,tests/**` |
200-
| `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/**` |
201-
| `use-ssh-source-format` | If enabled, all links to source code in generated Wiki documentation will use SSH standard format (e.g., `git::ssh://[email protected]/owner/repo.git`) instead of HTTPS format (`git::https://github.com/owner/repo.git`) | `false` |
187+
| Input | Description | Default |
188+
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
189+
| `major-keywords` | Keywords in commit messages that indicate a major release | `major change,breaking change` |
190+
| `minor-keywords` | Keywords in commit messages that indicate a minor release | `feat,feature` |
191+
| `patch-keywords` | Keywords in commit messages that indicate a patch release | `fix,chore,docs` |
192+
| `default-first-tag` | Specifies the default tag version | `v1.0.0` |
193+
| `terraform-docs-version` | Specifies the terraform-docs version used to generate documentation for the wiki | `v0.19.0` |
194+
| `delete-legacy-tags` | Specifies a boolean that determines whether tags and releases from Terraform modules that have been deleted should be automatically removed | `true` |
195+
| `disable-wiki` | Whether to disable wiki generation for Terraform modules | `false` |
196+
| `wiki-sidebar-changelog-max` | An integer that specifies how many changelog entries are displayed in the sidebar per module | `5` |
197+
| `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` |
198+
| `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) |
199+
| `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/**` |
200+
| `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/**` |
201+
| `use-ssh-source-format` | If enabled, all links to source code in generated Wiki documentation will use SSH standard format (e.g., `git::ssh://[email protected]/owner/repo.git`) instead of HTTPS format (`git::https://github.com/owner/repo.git`) | `false` |
202202

203203
### Understanding the filtering options
204204

@@ -339,8 +339,8 @@ The following outputs are available from this action:
339339
"changed-modules-map": {
340340
"aws/vpc": {
341341
"path": "modules/aws/vpc",
342-
"currentTag": "aws/vpc/v1.0.0",
343-
"nextTag": "aws/vpc/v1.1.0",
342+
"latestTag": "aws/vpc/v1.0.0",
343+
"releaseTag": "aws/vpc/v1.1.0",
344344
"releaseType": "minor"
345345
}
346346
},

0 commit comments

Comments
 (0)