Patch tfcmt plan
comment
tfcmt >= v3.2.0 | #199 #245 #248 #249
Instead of creating a new comment, you can update existing comment. This is useful to keep the pull request comments clean.
--
The option -patch
has been added to tfcmt plan
command.
tfcmt plan -patch -- terraform plan -no-color
And the configuration option plan_patch
has been added.
plan_patch: true
The command line option -patch
takes precedence over configuration file option plan_patch
.
If you want to disable patching although plan_patch
is true, please set -patch=false
.
$ tfcmt plan -patch=false -- terraform plan -no-color
Motivation
By patching the comment instead of creating a new comment, you can keep the pull request comments clean.
Trouble shooting
If the comment isn't patched expectedly, please set -log-level=debug
.
$ tfcmt -log-level=debug plan -patch -- terraform plan -no-color
⚠️ Note to use tfcmt plan's patch option with github-comment hide
If you hide comments by github-comment hide and enable tfcmt plan's patch option, you should be careful not to hide tfcmt plan's comments.
There are some ways to fix the problem.
- Stop using
github-comment hide
- Fix github-comment hide's condition and exclude tfcmt's comments from the target ofgithub-comment hide
- Run github-comment hide after tfcmt