Fix default in tfe_workspace documentation

[gtownend]

Description

Current documentation states that the default for file_triggers_enabled is false when the actual default is true

External links

Default value in code

[hashicorp-cla]

All committers have signed the CLA.

[brandonc]

Thank you very much for correcting this! The default was changed in 0.32.0 but the argument docs were not changed.

[philomory]

@brandonc As I understand it, in 0.32.0 the default was supposed to be changed to false (it was true previously), but the change was made incorrectly and so nothing was actually changed. You can see that the documentation was updated in #510, it was just updated under the assumption that the intended change to the default value was actually going to take effect.

This gets even more confusing because it was stated in #510 (and the release notes for 0.32.0) that the change to the default was intended to bring the default value into line with the default value of the corresponding attribute in TFC's API, but the API Documentation linked from the release notes clearly shows that the default value of data.attributes.file-triggers-enabled is true.

I know that changing the release notes of an already-released version after-the-fact is generally frowned upon, but you may wish to consider removing this from the release notes of version 0.32.0, because announcing a breaking change that never happens is pretty awkward as well:

r/tfe_workspace: Default value of the file_triggers_enabled field is changed to false. This will align the
file_triggers_enabled field default value with the default value for the same field in the
TFC API.
If the value of the file_triggers_enabled field was not explicitly set and either of the fields working_directory
(not an empty string) or trigger_prefixes was used - to keep the behavior unchanged, the file_trigger_enabled
field should now explicitly be set to true. (#510)

I don't know if @matejrisek, @omarismail, or @sebasslash want to weigh in on this? It's pretty confusing, I lost quite a bit of time today trying to work out what was going on.