Skip to content

Commit e315b74

Browse files
committed
Resolve markdownlint warnings for CHANGELOG.md
1 parent c65f744 commit e315b74

File tree

1 file changed

+66
-49
lines changed

1 file changed

+66
-49
lines changed

CHANGELOG.md

Lines changed: 66 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ When using an action you can specify the version as:
3131

3232
### Added
3333
- Support for Terraform 1.10 ephemeral input variables.
34-
34+
3535
Terraform 1.10 introduced ephemeral values, which are not stored in the plan or state file.
36-
Ephemeral variables now work correctly with [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply).
36+
Ephemeral variables now work correctly with [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply).
3737
These can be set normally using the `variables` input.
3838

3939
## [1.45.0] - 2024-12-24
@@ -70,7 +70,7 @@ When using an action you can specify the version as:
7070
This is only useful to avoid rate limiting when using the actions with GitHub Enterprise together with OpenTofu.
7171

7272
Normally the `GITHUB_TOKEN` environment variable is used for API requests. When using GitHub Enterprise, the `GITHUB_TOKEN` is the token for the GitHub Enterprise instance, and not the GitHub.com API.
73-
OpenTofu requires the GitHub.com API to fetch release information.
73+
OpenTofu requires the GitHub.com API to fetch release information.
7474

7575
## [1.41.2] - 2024-02-11
7676

@@ -95,7 +95,7 @@ When using an action you can specify the version as:
9595
- An optional `plan_path` input for [dflook/terraform-apply](terraform-apply), and matching `plan_path` output for [dflook/terraform-plan](terraform-plan).
9696

9797
This allows passing the generated plan from the plan step to the apply step, if you have a secure place to store it.
98-
98+
9999
The default behaviour when this is not set is unchanged - the apply step will generate a fresh plan and compare it to the plan from the PR comment.
100100
By passing the plan from the plan step to the apply step, the apply step will skip generating a plan and use the passed plan instead.
101101
It must still match the plan in the PR comment.
@@ -140,29 +140,29 @@ When using an action you can specify the version as:
140140
When [dflook/terraform-apply](terraform-apply) applies a plan, any PR comment will be updated with the results of the apply, and then no further updates will be made.
141141
Any further plans generated by [dflook/terraform-plan](terraform-plan) will result in a new plan in a different PR comment.
142142

143-
This is to avoid the comment being updated after the plan has been applied, which can be confusing.
143+
This is to avoid the comment being updated after the plan has been applied, which can be confusing.
144144
This would only happen if your workflow is to apply changes before merging the PR.
145145

146146
## [1.37.0] - 2023-10-29
147147

148148
### Added
149149

150-
- Experimental support for OpenTofu.
150+
- Experimental support for OpenTofu.
151151

152152
New tofu actions have been added that are identical to the terraform actions, but use OpenTofu instead of Terraform for versions >= 1.6.0.:
153-
- [dflook/tofu-version](tofu-version)
154-
- [dflook/tofu-remote-state](tofu-remote-state)
155-
- [dflook/tofu-output](tofu-output)
156-
- [dflook/tofu-validate](tofu-validate)
157-
- [dflook/tofu-fmt-check](tofu-fmt-check)
158-
- [dflook/tofu-fmt](tofu-fmt)
159-
- [dflook/tofu-check](tofu-check)
160-
- [dflook/tofu-plan](tofu-plan)
161-
- [dflook/tofu-apply](tofu-apply)
162-
- [dflook/tofu-destroy](tofu-destroy)
163-
- [dflook/tofu-new-workspace](tofu-new-workspace)
164-
- [dflook/tofu-destroy-workspace](tofu-destroy-workspace)
165-
- [dflook/tofu-unlock-state](tofu-unlock-state)
153+
* [dflook/tofu-version](tofu-version)
154+
* [dflook/tofu-remote-state](tofu-remote-state)
155+
* [dflook/tofu-output](tofu-output)
156+
* [dflook/tofu-validate](tofu-validate)
157+
* [dflook/tofu-fmt-check](tofu-fmt-check)
158+
* [dflook/tofu-fmt](tofu-fmt)
159+
* [dflook/tofu-check](tofu-check)
160+
* [dflook/tofu-plan](tofu-plan)
161+
* [dflook/tofu-apply](tofu-apply)
162+
* [dflook/tofu-destroy](tofu-destroy)
163+
* [dflook/tofu-new-workspace](tofu-new-workspace)
164+
* [dflook/tofu-destroy-workspace](tofu-destroy-workspace)
165+
* [dflook/tofu-unlock-state](tofu-unlock-state)
166166

167167
As OpenTofu currently only has pre-release versions, OpenTofu will only be selected by using the exact version number.
168168
The easiest way to do this is by setting the `OPENTOFU_VERSION` environment variable, e.g in your workflow:
@@ -205,7 +205,7 @@ When using an action you can specify the version as:
205205
## [1.35.0] - 2023-06-18
206206

207207
### Added
208-
- Support for partial or empty cloud blocks. This means you can use a placeholder `cloud` block in your terraform, like so:
208+
- Support for partial or empty cloud blocks. This means you can use a placeholder `cloud` block in your terraform, like so:
209209

210210
```hcl
211211
terraform {
@@ -249,7 +249,7 @@ terraform {
249249

250250
### Changed
251251
- If a terraform operation fails because the state is locked the `failure-reason` output will now be set to `state-locked`,
252-
where before it may have been `apply-failed` or `destroy-failed`.
252+
where before it may have been `apply-failed` or `destroy-failed`.
253253

254254
## [1.31.1] - 2022-12-01
255255

@@ -273,7 +273,7 @@ terraform {
273273
## [1.29.1] - 2022-10-24
274274

275275
### Fixed
276-
- Multiline string terraform outputs are now properly set as action outputs, and properly masked in the workflow log.
276+
- Multiline string terraform outputs are now properly set as action outputs, and properly masked in the workflow log.
277277

278278
## [1.29.0] - 2022-10-17
279279

@@ -321,15 +321,16 @@ terraform {
321321
## [1.25.0] - 2022-05-06
322322

323323
### Added
324-
- New `run_id` output for [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply) which are set when using Terraform Cloud/Enterprise. It is the remote run-id of the plan or apply operation.
324+
- New `run_id` output for [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) and [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply) which are set when using Terraform Cloud/Enterprise.
325+
It is the remote run-id of the plan or apply operation.
325326
- The `json_plan_path` output of [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) now works when using Terraform Cloud/Enterprise.
326327

327328
## [1.24.0] - 2022-05-03
328329

329330
### Added
330331
- New `to_add`, `to_change` and `to_destroy` outputs for the [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) action that contain the number of resources that would be added, changed or deleted by the plan.
331332

332-
These can be used in an [if expression](https://docs.github.com/en/enterprise-server@3.2/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif) in a workflow to conditionally run steps, e.g. when the plan would destroy something.
333+
These can be used in an [if expression](https://docs.github.com/en/enterprise-server@3.2/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif) in a workflow to conditionally run steps, e.g. when the plan would destroy something.
333334

334335
## [1.23.0] - 2022-05-02
335336

@@ -343,7 +344,7 @@ terraform {
343344
### Fixed
344345
- Pre-release terraform versions now won't be used when selecting the latest terraform version.
345346
- Invalid terraform files that contained an unterminated string would take an extremely long time to parse before failing the job.
346-
- [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate) now automatically sets `terraform.workspace` to `default` when validating a module that uses a `remote` or `cloud` backend.
347+
- [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate) now automatically sets `terraform.workspace` to `default` when validating a module that uses a `remote` or `cloud` backend.
347348

348349
## [1.22.2] - 2022-02-28
349350

@@ -360,16 +361,17 @@ terraform {
360361

361362
### Added
362363
- Workspace management for Terraform Cloud/Enterprise has been reimplemented to avoid issues with the `terraform workspace` command when using the `remote` backend or a cloud config block:
363-
- [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-new-workspace) can now create the first workspace
364-
- [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-destroy-workspace) can now delete the last remaining workspace
365-
- [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-new-workspace) and [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-destroy-workspace) work with a `remote` backend that specifies a workspace by `name`
364+
* [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-new-workspace) can now create the first workspace
365+
* [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-destroy-workspace) can now delete the last remaining workspace
366+
* [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-new-workspace) and [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-destroy-workspace)
367+
work with a `remote` backend that specifies a workspace by `name`
366368

367369
- The terraform version to use will now be detected from additional places:
368370

369-
- The terraform version set in the remote workspace when using Terraform Cloud/Enterprise as the backend
370-
- An [asdf](https://asdf-vm.com/) `.tool-versions` file
371-
- The terraform version that wrote an existing state file
372-
- A `TERRAFORM_VERSION` environment variable
371+
* The terraform version set in the remote workspace when using Terraform Cloud/Enterprise as the backend
372+
* An [asdf](https://asdf-vm.com/) `.tool-versions` file
373+
* The terraform version that wrote an existing state file
374+
* A `TERRAFORM_VERSION` environment variable
373375

374376
The best way to specify the version is using a [`required_version`](https://www.terraform.io/docs/configuration/terraform.html#specifying-a-required-terraform-version) constraint.
375377

@@ -378,13 +380,19 @@ terraform {
378380
### Changed
379381
As a result of the above terraform version detection additions, note these changes:
380382

381-
- Actions always use the terraform version set in the remote workspace when using TFC/E, if it exists. This mostly effects [dflook/terraform-fmt](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt), [dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt-check) and [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate).
383+
- Actions always use the terraform version set in the remote workspace when using TFC/E, if it exists. This mostly
384+
effects [dflook/terraform-fmt](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt),
385+
[dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt-check) and
386+
[dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate).
382387

383388
- If the terraform version is not specified anywhere then new workspaces will be created with the latest terraform version. Existing workspaces will use the terraform version that was last used for that workspace.
384389

385390
- If you want to always use the latest terraform version, instead of not specifying a version you now need to set an open-ended version constraint (e.g. `>1.0.0`)
386391

387-
- All actions now support the inputs and environment variables related to the backend, for discovering the terraform version from a TFC/E workspace or remote state. This add the inputs `workspace`, `backend_config`, `backend_config_file`, and the `TERRAFORM_CLOUD_TOKENS` environment variable to the [dflook/terraform-fmt](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt), [dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt-check) and [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate) actions.
392+
- All actions now support the inputs and environment variables related to the backend, for discovering the terraform
393+
version from a TFC/E workspace or remote state. This add the inputs `workspace`, `backend_config`,
394+
`backend_config_file`, and the `TERRAFORM_CLOUD_TOKENS` environment variable to the [dflook/terraform-fmt](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt),
395+
[dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/main/terraform-fmt-check) and [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate) actions.
388396

389397
- :warning: Some unused packages were removed from the container image, most notably Python 2.
390398

@@ -394,14 +402,14 @@ As a result of the above terraform version detection additions, note these chang
394402
- [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/main/terraform-new-workspace) support for Terraform v1.1.0.
395403

396404
This stopped working after a change in the behaviour of terraform init.
397-
405+
398406
There is an outstanding [issue in Terraform v1.1.0](https://github.com/hashicorp/terraform/issues/30129) using the `remote` backend that prevents creating a new workspace when no workspaces currently exist.
399407
If you are affected by this, you can pin to an earlier version of Terraform using one of methods listed in the [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) docs.
400408

401409
## [1.21.0] - 2021-12-04
402410

403411
### Added
404-
- A new `workspace` input for [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate)
412+
- A new `workspace` input for [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/main/terraform-validate)
405413
allows validating usage of `terraform.workspace` in the terraform code.
406414

407415
Terraform doesn't initialize `terraform.workspace` based on the backend configuration when running a validate operation.
@@ -420,7 +428,8 @@ As a result of the above terraform version detection additions, note these chang
420428

421429
These are paths to the generated plan in human-readable and JSON formats.
422430

423-
If the plan generated by [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) is different from the plan generated by [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply) the apply step will fail with `failure-reason` set to `plan-changed`.
431+
If the plan generated by [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/main/terraform-plan) is different from the plan generated by
432+
[dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/main/terraform-apply) the apply step will fail with `failure-reason` set to `plan-changed`.
424433
These new outputs make it easier to inspect the differences.
425434

426435
## [1.19.0] - 2021-11-01
@@ -454,6 +463,13 @@ As a result of the above terraform version detection additions, note these chang
454463
kubernetes_secret.tls_cert_private
455464
```
456465

466+
## [1.17.3] - 2021-10-29
467+
468+
### Fixed
469+
- [dflook/terraform-new-workspace](https://github.com/dflook/terraform-github-actions/tree/master/terraform-new-workspace)
470+
compatability with Terraform v1.0.10 - Thanks [kylewlacy](https://github.com/kylewlacy)!
471+
- Now makes even fewer GitHub api requests to avoid rate limiting.
472+
457473
## [1.17.2] - 2021-10-13
458474

459475
### Fixed
@@ -479,8 +495,8 @@ As a result of the above terraform version detection additions, note these chang
479495

480496
### Added
481497
- [dflook/terraform-plan](https://github.com/dflook/terraform-github-actions/tree/master/terraform-plan) has gained two new outputs:
482-
- `json_plan_path` is a path to the generated plan in a JSON format file
483-
- `text_plan_path` is a path to the generated plan in a human-readable text file
498+
* `json_plan_path` is a path to the generated plan in a JSON format file
499+
* `text_plan_path` is a path to the generated plan in a human-readable text file
484500

485501
These paths are relative to the GitHub Actions workspace and can be read by other steps in the same job.
486502

@@ -490,12 +506,12 @@ As a result of the above terraform version detection additions, note these chang
490506
- Actions that intentionally cause a build failure now set a `failure-reason` output to enable safely responding to those failures.
491507

492508
Possible failure reasons are:
493-
- [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/master/terraform-validate#outputs): validate-failed
494-
- [dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/master/terraform-fmt-check#outputs): check-failed
495-
- [dflook/terraform-check](https://github.com/dflook/terraform-github-actions/tree/master/terraform-check#outputs): changes-to-apply
496-
- [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/master/terraform-apply#outputs): apply-failed, plan-changed
497-
- [dflook/terraform-destroy](https://github.com/dflook/terraform-github-actions/tree/master/terraform-destroy#outputs): destroy-failed
498-
- [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/master/terraform-destroy-workspace#outputs): destroy-failed
509+
* [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/master/terraform-validate#outputs): validate-failed
510+
* [dflook/terraform-fmt-check](https://github.com/dflook/terraform-github-actions/tree/master/terraform-fmt-check#outputs): check-failed
511+
* [dflook/terraform-check](https://github.com/dflook/terraform-github-actions/tree/master/terraform-check#outputs): changes-to-apply
512+
* [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/tree/master/terraform-apply#outputs): apply-failed, plan-changed
513+
* [dflook/terraform-destroy](https://github.com/dflook/terraform-github-actions/tree/master/terraform-destroy#outputs): destroy-failed
514+
* [dflook/terraform-destroy-workspace](https://github.com/dflook/terraform-github-actions/tree/master/terraform-destroy-workspace#outputs): destroy-failed
499515

500516
### Fixed
501517
- [dflook/terraform-validate](https://github.com/dflook/terraform-github-actions/tree/master/terraform-validate) was sometimes unable to create detailed check failures.
@@ -525,6 +541,7 @@ As a result of the above terraform version detection additions, note these chang
525541
The runtime image is currently based on `debian:buster`, with the command run using `bash -xeo pipefail`.
526542

527543
For example:
544+
528545
```yaml
529546
env:
530547
TERRAFORM_PRE_RUN: |
@@ -550,7 +567,7 @@ As a result of the above terraform version detection additions, note these chang
550567

551568
### Changed
552569
- Improved messaging in the workflow log when [terraform-apply](https://github.com/dflook/terraform-github-actions/tree/master/terraform-apply) is aborted because the plan has changed
553-
- Update documentation for `backend_config`, `backend_config_file`, `var_file` & `target` inputs to use separate lines for multiple values.
570+
- Update documentation for `backend_config`, `backend_config_file`, `var_file` & `target` inputs to use separate lines for multiple values.
554571
Multiple values may still be separated by commas if preferred.
555572

556573
## [1.10.0] - 2021-05-30
@@ -587,9 +604,9 @@ As a result of the above terraform version detection additions, note these chang
587604

588605
### Deprecated
589606
- The `var` input has been deprecated due to the following limitations:
590-
- Only primitive types can be set with `var` - number, bool and string.
591-
- String values may not contain a comma.
592-
- Values set with `var` will be overridden by values contained in `var_file`s
607+
* Only primitive types can be set with `var` - number, bool and string.
608+
* String values may not contain a comma.
609+
* Values set with `var` will be overridden by values contained in `var_file`s
593610

594611
`variables` is the preferred way to set input variables.
595612

0 commit comments

Comments
 (0)