fix(terraform_docs): Always use GNU sed

Ensure sed commands are compatible with MacOS and Linux/GNO version
antonbabenko · Aug 29, 2024 · de569e0 · de569e0
1 parent 99fceb8
commit de569e0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -585,8 +585,8 @@ Unlike most other hooks, this hook triggers once if there are any changed files
       To migrate everything to `terraform-docs` insertion markers, run in repo root:
 
       ```bash
-      grep -rl 'BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK' . | xargs sed -i 's/BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK/BEGIN_TF_DOCS/g'
-      grep -rl 'END OF PRE-COMMIT-TERRAFORM DOCS HOOK' . | xargs sed -i 's/END OF PRE-COMMIT-TERRAFORM DOCS HOOK/END_TF_DOCS/g'
+      grep -rl 'BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK' . | xargs sed -i'' 's/BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK/BEGIN_TF_DOCS/g'
+      grep -rl 'END OF PRE-COMMIT-TERRAFORM DOCS HOOK' . | xargs sed -i'' 's/END OF PRE-COMMIT-TERRAFORM DOCS HOOK/END_TF_DOCS/g'
       ```
 
     ```yaml

diff --git a/hooks/terraform_docs.sh b/hooks/terraform_docs.sh
@@ -40,8 +40,8 @@ function main {
 function replace_old_markers {
   local -r file=$1
 
-  sed -i "s/^${old_insertion_marker_begin}$/${insertion_marker_begin}/" "$file"
-  sed -i "s/^${old_insertion_marker_end}$/${insertion_marker_end}/" "$file"
+  sed -i'' "s/^${old_insertion_marker_begin}$/${insertion_marker_begin}/" "$file"
+  sed -i''  "s/^${old_insertion_marker_end}$/${insertion_marker_end}/" "$file"
 }
 
 #######################################################################