chore: print warning logs about overwritten workflows (#114)

* chore: print warning logs about overwritten workflows * Update readme.md * Update readme.md Co-authored-by: Maciej Stosio <[email protected]> --------- Co-authored-by: Maciej Stosio <[email protected]>
software-mansion · Sep 19, 2024 · e9199f6 · e9199f6
1 parent 46e637e
commit e9199f6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -18,6 +18,9 @@ then select the setup that matches your project - `npx setup-ci` generates workf
 
 If your project has a monorepo structure, run the script from the root directory of the app for which you want to set up workflows.
 
+> [!WARNING]
+> If you re-run `npx setup-ci` in the same project or already have some workflows set up manually, they might get overwritten. Therefore, we recommend running the script with no uncommitted changes, so you can easily inspect the diff after script execution.
+
 ## 💡 Demo
 
 Say we want to set up GitHub actions that run Typescript and Prettier checks on our project every time we create or push to an existing Pull Request.

diff --git a/src/extensions/workflows.ts b/src/extensions/workflows.ts
@@ -45,6 +45,12 @@ module.exports = (toolbox: CycliToolbox) => {
       workflowFileName
     )
 
+    if (toolbox.filesystem.exists(target)) {
+      toolbox.interactive.warning(
+        `Workflow file ${workflowFileName} already exists and will be overwritten.`
+      )
+    }
+
     toolbox.filesystem.write(target, workflowString)
 
     toolbox.interactive.step(`Created ${workflowFileName} workflow file.`)