Releases: OP5dev/TF-via-PR
Releases · OP5dev/TF-via-PR
v11.0.1
Updated
- Include more documentation examples with
arg_lock
for real-world use-cases (thanks @garysassano). - Reorder input arguments for better presentation of identifying information first.
- Switch sample-bucket resources to use
tofu
-provisioned setup.
Fixed
- Check for
tofu
CLI in PATH and use it if available.
Commits changelog: v11.0.0...v11.0.1
v11.0.0 Pass Command Arguments with more PR Automation
Highlights
- Input individual command arguments instead of a string.
- Expand support for PR automation event triggers.
Added
- Separate input parameters for each command argument passed into TF.
- Leverage github-script instead of bash for handling workflow logic and GitHub API.
- Support for
tenv
to avoid TF wrapper script.
Updated
- Example workflows for common use-cases and event triggers.
- Sample workflow to consolidate with matrix strategy and deployment environments.
- Readme documentation with up-to-date screenshot and guidance.
Changed
- Refactor input parameter names:
Before After Default command_input
args_*
cli_uses
tf_tool
terraform
label_enable
label_pr
true
plan_outline
outline_enable
true
recreate_comment
update_comment
false
- Refactor output parameter names:
Before After command
header
comment_summary
summary
plan_id
identifier
tf_fmt
fmt_result
tf_output
last_result
Removed
- Support for
issue_comment
event trigger in order to focus on PR automation events.
Fixed
- #237 by fetching the job name with several methods until GitHub fixes it.
- #238 by enabling compatibility with
workflow_dispatch
event trigger while using0
as a placeholder PR number. - #243 by confirming compatibility with
merge_group
event trigger and documenting workflow example. - #245 by confirming compatibility with
push
event trigger and documenting workflow example.
Secured
- Support for v11.0.0 and above.
Todo
- Add workflow example for interactive PR label trigger.
- Add support for
terragrunt
thin wrapper, per #258.
Commits changelog: v10.7.0...v11.0.0
v11.0.0-rc.1
Warning
This pre-release candidate is unsuitable for use in production.
Added
- Support for
merge_group
trigger event or merge queue.
Changed
- Pass TF CLI input options via
arg_
prefixed parameters, instead of a big ol'command_input
string.
Removed
- Support for
issue_comment
trigger event or PR comments. - Support for
force-unlock
command.
Fixed
- Reference to jobs with custom names.
Todo
- Update corresponding readme documentation.
- Update associated workflow examples for new input parameters.
- Ensure compatibility with
push
andworkflow_dispatch
trigger events.
Commits changelog: v10.6.0...v11.0.0-rc.1
v10.7.0: Add support for `merge_group` event trigger
v10: Run TF directly via workflow input in addition to PR comments
Highlight
In addition to the existing PR comment trigger, support TF execution directly via command_input
within the workflow to enable more flexible and dynamic use-cases, including parallel runs in matrix strategy.
Added
- Support TF execution directly via
command_input
string. - Multiple workflow examples with associated permissions and triggers for usage clarity.
- Cache TF plugins to speed up workflow run times, optionally.
- TF Tests workflow to validate GitHub Action against various sample Terraform configurations.
- Badges/shields at the top of the README to show(-off) notable metrics and metadata.
- Support
recreate_comment
boolean flag to optionally delete and re-add PR comments after any updates/commits made on the PR branch to make the conversation easier to follow. - Support
-concise
flag to reduce verbosity of OpenTofu output.
Changed
- Streamline calls to "github-script" with
await require(...)
one-liner. - Rename GitHub Action to prioritise/emphasise OpenTofu support.
- Bump up character limits of TF output (51200 → 66000) and format diff (10240 → 12000).
- Set default values for boolean inputs to reduce usage ambiguity.
Fixed
- Support
-or-create
flag for more appropriate TF workspace creation via CI.
Deprecated
- Explicit requirement on defining
cli_uses
input in favour of assuming it automatically from the prior TF-setup step with the wrapper enabled.
Secured
- Document best practices for using 3rd party GitHub Actions in a secure manner.
- Support v10.X and above.
Commits changelog: v9.1.0...v10
v10.6.0: Color-coded TF plan change outline summary
Added
- Diff indicators to color-code change outline. (#227 #235)
+ resource.address will be created - resource.address will be destroyed ! resource.address will be updated or replaced # resource.address has been changed
- Option to toggle addition of PR labels via
label_enable
input parameter. (#231)
Changed
- Simplify sample workflow trigger and scope. (#221 #222 #226 #234)
- Emphasize use of PR trigger input for automation, over PR comments. (#232)
- (meta) Relocate codeowners file to .github directory. (#228 #229 #230)
- (meta) Enable dependabot wildcard matching. (#219)
- (meta) Bumped terraform deps. (#217 #218 #220 #224 #225)
Fixed
- (meta) GitHub Marketplace link. (#223)
Security
- Highlight that only official GitHub Actions are used. (#233)
Commits changelog: v10.5.0...v10.6.0
v10.5.0
v10.4.0
Added
- Append outline of planned changes to the PR comment, truncated to the first 12,000 characters (e.g.,
random_pet.name[0] will be created
).
Commits changelog: v10.3.0...v10.4.0
v10.3.0
Added
- Output
comment_summary
of TF output (e.g., "Plan: 1 to add, 0 to change, 0 to destroy.")- Requires
checks: write
permission.
- Requires
- Copy TF output to the job summary for easier access within GitHub Actions > Jobs.
Changed
- (meta) Dependabot configuration to keep Terraform dependencies up-to-date in a group (until OpenTofu catches up).
- (meta) Formatted yml → yaml workflows for consistency and legibility.
Security
- Explicitly list all 3 GitHub Actions used by this workflow and the steps taken to prevent supply chain attacks from upstream dependencies:
Commits changelog: v10.2.0...v10.3.0
v10.2.0
Added
- Example workflow using
tenv
proxy (thank you @dvaumoron and @kvendingoldo!). - Output
comment_id
of the PR comment created or updated by the workflow. - Markdown comments
<!-- pre_output -->
and<!-- post_output -->
within PR comment to enable user-driven replacements.
Changed
- Rename repository from "TF-via-PR-Comments" to "TF-via-PR" to better indicate the wider scope of PR-based automation.
- Amend default
recreate_comment
fromfalse
totrue
. - Amend default
validate_enable
fromtrue
tofalse
. - Example workflows use Actions with simpler pinned tags for legibility.
Fixed
- Argument input
-concise
gets pass to-tf=plan
as expected. - (meta) Path filters to only trigger
tf_test.yml
workflow on changes to specific (sub-)directories.
Commits changelog: v10.1.0...v10.2.0