Create a Code Automation

How to create your first CodeSee Code Automation

To create a new Code Automations, navigate to the Triggers home page and click "Add Trigger".

You'll be presented with a form to set up your new Code Automation. After choosing a descriptive name, you'll be prompted to choose the target repository from a list. This cannot be changed after the Trigger is created.

Conditions

Next up, you will set up conditions, which are a list of criteria that determine when an Automation should execute.

We currently support 2 filters: "File name" and "File added in folder".

File name filter

This filter matches against the name of files in your repository

📘

A file path is different from a file name

For example: src/app/index.ts is a file path, while index.ts is a file name.

File added in folder filter

This filter matches files that were added to a specific folder in a pull request.

For example, the filter "File added in folder" with the operator "folder path equals" with the value "src/components/icons" would match any file that was added in that folder.

An example condition that applies to files added in a folderAn example condition that applies to files added in a folder

An example condition that applies to files added in a folder

Previewing

Use the "Preview" panel on the right to verify the conditions of your Automation.

Note: when previewing the "File added in folder" condition, the Preview panel will show existing files, but note that your Trigger will only execute when new files are added to the matching folders.

Actions

4 kinds of actions are currently supported: posting a comment, adding a checklist item, assigning a pull request, and assigning a reviewer.

Add a comment to a pull request

When this action is executed, CodeSee will post the comment on the matching pull request.

Add a checklist item to a pull request

When this action is executed, CodeSee will add a new checklist item to the PR description. You can add as many checklist items as you need by adding an action for each item.

Assign a pull request to someone

When this action is executed, CodeSee will assign the pull request to the GitHub user of your choice.

Note: a pull request can only be assigned to a single person, and never to the author of the pull request.

Assign someone as a reviewer

When this action is executed, CodeSee will assign the person of your choice as a reviewer on the PR. If you'd like to add multiple assignees, you can create multiple instances of this action on the same Trigger.

Example

An example of actions defined on a TriggerAn example of actions defined on a Trigger

An example of actions defined on a Trigger


Did this page help you?