Skip to content

added troubleshooting #698

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
Apr 24, 2025
Merged

added troubleshooting #698

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
11 changes: 11 additions & 0 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,17 @@ Clicking the `Details` button will show more information and context.

You can add this automation to see details on context variable.

#### gitStream fails when using template strings with special characters (e.g., colon ':')

If a template string (e.g., pull request title, description, or other context variables) contains special characters such as a colon (`:`), gitStream might fail with a YAML parsing error due to invalid syntax.

To resolve this issue, ensure you properly escape special characters by using Nunjucks multiline strings. For example:

```yaml+jinja
comment: |
{{ pr.title }}
```

## How can I debug expressions and see their content?

You can dump any context value to the PR comment. For example, to see the list of changed files, use:
Expand Down