Skip to content

FAQ

What permissions are needed?

In your repo permissions, make sure GitHub actions are permitted:

Go to Repo's settings > Actions > General > Actions permissions

Choose which repositories are permitted to use GitHub Actions.

[x] Allow all actions and reusable workflows

Does gitStream services have access to my code?

Like any other CI/CD automation, the source code is being scanned in the repo and is not shared with any external services. Only metadata related to and affecting the workflow is shared to allow rule-based automation on the repo.

Why does gitStream require permission to write code?

To support automations that either Approve or Merge PRs, the git providers require code write scope.

What repos are supported?

gitStream supports repositories in GitHub, GitLab, and Bitbucket. Note that the add-label action is not supported in Bitbucket as it does not have a native labeling feature.

Can I use gitStream with Merge Queues?

Yes. When a merge queue is used, and gitStream is set as a required check, gitStream automation will be invoked with the merge event. The automation will set gitStream to a Completed status and Skipped conclusion to allow the PR merge. gitStream with Merge Queue

Is there .cm syntax highlighting?

The .cm file uses YAML with JINJA2. For your favorite editor to automatically choose the right syntax, you can use modelines.

Add the following line to the top of the .cm file (the default has it already): 

# -*- mode: yaml -*-

Get a plug-in that enables modelines. Popular ones are:

I have an issue I can't seem to solve. What should I do?

Go to our issues page and check if any similar issues are already reported. If not, create a new issue with all the details so we can take a look.

Found a bug? Create a new item in the project's issues