Skip to content

Commit d7f5184

Browse files
authored
feat: prettier in READMEs (cloudposse/terraform-aws-components#998)
1 parent 025a146 commit d7f5184

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

src/CHANGELOG.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
### Fix for `enabled = false` or Destroy and Recreate
44

5-
Previously, when `enabled = false` was set, the component would not necessarily
6-
function as desired (deleting any existing resources and not creating any new ones).
7-
Also, previously, when deleting the component, there was a race condition where
8-
the log group could be deleted before the lambda function was deleted, causing
9-
the lambda function to trigger automatic recreation of the log group. This
10-
would result in re-creation failing because Terraform would try to create the
11-
log group but it already existed.
5+
Previously, when `enabled = false` was set, the component would not necessarily function as desired (deleting any
6+
existing resources and not creating any new ones). Also, previously, when deleting the component, there was a race
7+
condition where the log group could be deleted before the lambda function was deleted, causing the lambda function to
8+
trigger automatic recreation of the log group. This would result in re-creation failing because Terraform would try to
9+
create the log group but it already existed.
1210

1311
These issues have been fixed in this PR.

src/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Component: `datadog-lambda-forwarder`
22

3-
This component is responsible for provision all the necessary infrastructure to
4-
deploy [Datadog Lambda forwarders](https://github.com/DataDog/datadog-serverless-functions/tree/master/aws/logs_monitoring). It depends on
5-
the `datadog-configuration` component to get the Datadog API keys.
6-
3+
This component is responsible for provision all the necessary infrastructure to deploy
4+
[Datadog Lambda forwarders](https://github.com/DataDog/datadog-serverless-functions/tree/master/aws/logs_monitoring). It
5+
depends on the `datadog-configuration` component to get the Datadog API keys.
76

87
## Usage
98

@@ -44,6 +43,7 @@ components:
4443
filter_pattern: ""
4544
```
4645
46+
<!-- prettier-ignore-start -->
4747
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
4848
## Requirements
4949
@@ -150,11 +150,12 @@ components:
150150
| <a name="output_lambda_forwarder_vpc_log_function_arn"></a> [lambda\_forwarder\_vpc\_log\_function\_arn](#output\_lambda\_forwarder\_vpc\_log\_function\_arn) | Datadog Lambda forwarder VPC Flow Logs function ARN |
151151
| <a name="output_lambda_forwarder_vpc_log_function_name"></a> [lambda\_forwarder\_vpc\_log\_function\_name](#output\_lambda\_forwarder\_vpc\_log\_function\_name) | Datadog Lambda forwarder VPC Flow Logs function name |
152152
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
153-
153+
<!-- prettier-ignore-end -->
154154

155155
## References
156-
* Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys
157-
* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-lambda-forwarder) - Cloud Posse's upstream component
158156

157+
- Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys
158+
- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-lambda-forwarder) -
159+
Cloud Posse's upstream component
159160

160161
[<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)

0 commit comments

Comments
 (0)