Merge pull request #84 from tighten/adc/gh-action-commit-note

Add notices about commits and workflows

Author: driftingly

README.md

@@ -137,6 +137,22 @@ Create a `pint.json` file in your project root, you can use [Duster's `pint.json
 
 There's a [GitHub Action](https://github.com/tighten/duster-action) you use to clean-up your workflows.
 
+
+
+>**Warning** Heads Up! Workflows that commit to your repo will stop any currently running workflows and not trigger another workflow run.
+
+One solution is to run your other workflows after Duster has completed by updating the trigger on those workflows:
+
+```yml
+on:
+  # Commits made in Duster Fix will not trigger any workflows
+  # This workflow is configured to run after Duster finishes
+  workflow_run:
+    workflows: ["Duster Fix"]
+    types:
+      - completed
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

app/Commands/GitHubActionsCommand.php

@@ -2,6 +2,7 @@
 
 namespace App\Commands;
 
+use Illuminate\Support\Str;
 use LaravelZero\Framework\Commands\Command;
 
 use function Termwind\{render};
@@ -25,6 +26,14 @@ public function handle(): int
 
         $workflowName = $choices[$choice];
 
+        if (Str::contains($workflowName, 'fix')) {
+            $this->warn('The resulting commit will stop any currently running workflows and will not trigger another.');
+            $this->warn('Checkout Duster\'s documentation for a workaround.');
+            if (! $this->confirm('Do you wish to continue?', true)) {
+                return Command::FAILURE;
+            }
+        }
+
         $workflow = file_get_contents(__DIR__ . "/../../stubs/github-actions/{$workflowName}.yml");
         $workflow = str_replace('YOUR_BRANCH_NAME', $branch, $workflow);
 

stubs/github-actions/duster-fix-blame.yml

@@ -1,5 +1,8 @@
 name: Duster Fix
 
+# Commits made in here will not trigger any workflows
+# Checkout Duster's documentation for a workaround
+
 on:
     push:
         branches: [ YOUR_BRANCH_NAME ]

stubs/github-actions/duster-fix.yml

@@ -1,5 +1,8 @@
 name: Duster Fix
 
+# Commits made in here will not trigger any workflows
+# Checkout Duster's documentation for a workaround
+
 on:
     push:
         branches: [ YOUR_BRANCH_NAME ]