feat: prettier in READMEs (cloudposse/terraform-aws-components#998)

Author: milldr

src/CHANGELOG.md

@@ -1,11 +1,11 @@
 ## Components PR [#851](https://github.com/cloudposse/terraform-aws-components/pull/851)
 
-This is a bug fix and feature enhancement update.
-There are few actions necessary to upgrade.
+This is a bug fix and feature enhancement update. There are few actions necessary to upgrade.
 
 ## Upgrade actions
 
 1. Enable `github_default_notifications_enabled` (set `true`)
+
 ```yaml
 components:
   terraform:
@@ -16,21 +16,23 @@ components:
         enabled: true
         github_default_notifications_enabled: true
 ```
-2. Apply changes with Atmos
 
+2. Apply changes with Atmos
 
 ## Features
-* Support predefined GitHub commit status notifications for CD sync mode:
-  * `on-deploy-started`
-    * `app-repo-github-commit-status`
-    * `argocd-repo-github-commit-status`
-  * `on-deploy-succeded`
-    * `app-repo-github-commit-status`
-    * `argocd-repo-github-commit-status`
-  * `on-deploy-failed`
-    * `app-repo-github-commit-status`
-    * `argocd-repo-github-commit-status`
+
+- Support predefined GitHub commit status notifications for CD sync mode:
+  - `on-deploy-started`
+    - `app-repo-github-commit-status`
+    - `argocd-repo-github-commit-status`
+  - `on-deploy-succeded`
+    - `app-repo-github-commit-status`
+    - `argocd-repo-github-commit-status`
+  - `on-deploy-failed`
+    - `app-repo-github-commit-status`
+    - `argocd-repo-github-commit-status`
 
 ### Bug Fixes
 
-* Remove legacy unnecessary helm values used in old ArgoCD versions (ex. `workflow auth` configs) and dropped notifications services
+- Remove legacy unnecessary helm values used in old ArgoCD versions (ex. `workflow auth` configs) and dropped
+  notifications services

src/README.md

@@ -57,9 +57,8 @@ components:
 ```yaml
 # stacks/mgmt-gbl-corp.yaml
 import:
-...
-  - catalog/argocd/repo/non-prod
-...
+---
+- catalog/argocd/repo/non-prod
 ```
 
 If the repository already exists, it will need to be imported (replace names of IAM profile var file accordingly):
@@ -76,6 +75,7 @@ $ cd components/terraform/argocd-repo
 $ terraform import -var "import_profile_name=eg-mgmt-gbl-corp-admin" -var-file="mgmt-gbl-corp-argocd-deploy-non-prod.terraform.tfvars.json" "github_branch_default.default[0]" argocd-deploy-non-prod
 ```
 
+<!-- prettier-ignore-start -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
 
@@ -179,10 +179,11 @@ $ terraform import -var "import_profile_name=eg-mgmt-gbl-corp-admin" -var-file="
 | <a name="output_repository_ssh_clone_url"></a> [repository\_ssh\_clone\_url](#output\_repository\_ssh\_clone\_url) | Repository SSH clone URL |
 | <a name="output_repository_url"></a> [repository\_url](#output\_repository\_url) | Repository URL |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
+<!-- prettier-ignore-end -->
 
 ## References
-  * [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/argocd-repo) - Cloud Posse's upstream component
 
+- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/argocd-repo) -
+  Cloud Posse's upstream component
 
 [<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)