Skip to content

Commit

Permalink
📝 Document New Excludes Preference
Browse files Browse the repository at this point in the history
/close #work
  • Loading branch information
ryandens authored and gilday committed Jul 10, 2024
1 parent 084238d commit a982675
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions docs/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ ai:
### `codemods`

Contains optional settings related to the codemod catalog Pixeebot uses to make changes to repositories.
Contains optional preferences related to the codemod catalog Pixeebot uses to
make changes to repositories.

#### `catalog`

Expand All @@ -65,7 +66,8 @@ codemods:

#### `exclude`

A set of codemods to exclude from the catalog. Each codemod is identified by its codemod ID.
A set of codemods to exclude from the catalog. Each codemod is identified by its
codemod ID.

Example:

Expand All @@ -89,6 +91,25 @@ codemods:
- pixee:python/use-walrus-if
```

### `paths`

Contains optional preferences for controlling the files and directories that are
included in Pixeebot analysis.

#### `exclude`

A set of paths to files or directories to exclude from Pixeebot analysis. Each
path is relative to the root of the repository. Each path in the set may be a
file, directory, or UNIX glob pattern.

Example:

```yaml
paths:
exclude:
- buildSrc/
```

## Configuring automatic assignment

To automatically assign **reviewers** to Pixeebot PRs, consider [setting up a `CODEOWNERS` file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).
Expand Down

0 comments on commit a982675

Please sign in to comment.