Skip to content

Update dry-run-mode.md #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

Update dry-run-mode.md #705

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/dry-run-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@ Testing your gitStream automations ensures they work as expected before applying

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

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

![dry-run mode](/screenshots/dry-run-mode.png)

!!! note
While in Dry Run mode, no automation changes actually take effect. To apply your automations, merge your PR after validation.

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

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.

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.
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.