Skip to content

Commit e179674

Browse files
authored
Merge pull request #705 from linear-b/fix-CR-for-dry-run
Update dry-run-mode.md
2 parents c2504ef + 617c60a commit e179674

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/dry-run-mode.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ Testing your gitStream automations ensures they work as expected before applying
1111

1212
Dry Run mode is automatically enabled whenever you open a PR that modifies any of your `.cm` automation files. In Dry Run mode:
1313

14-
- gitStream evaluates all automations without executing them.
14+
- gitStream evaluates automations based on code changes made to non-automation files (your repository's codebase).
15+
- Automations are evaluated without being executed.
1516
- Results are added as comments on your pull request, showing exactly what actions would have occurred.
1617
- Each new commit triggers an updated comment describing the changes.
1718

19+
![dry-run mode](/screenshots/dry-run-mode.png)
20+
1821
!!! note
1922
While in Dry Run mode, no automation changes actually take effect. To apply your automations, merge your PR after validation.
2023

@@ -24,4 +27,4 @@ If you encounter issues while testing, refer to our [Troubleshooting page](troub
2427

2528
You can also test automations interactively using the [gitStream Playground](gitStream-playground.md). The Playground offers an intuitive environment to preview how automations behave, allowing you to instantly adjust and perfect your rules.
2629

27-
Select the method most convenient for your workflow, or use both methods together for comprehensive testing. Once satisfied with the results, merge your `cm` changes into the main branch to enable the new automations.
30+
Select the method most convenient for your workflow, or use both methods together for comprehensive testing. Once satisfied with the results, merge your `.cm` changes into the main branch to enable the new automations.

0 commit comments

Comments
 (0)