Skip to content

Commit

Permalink
Add section about codemod catalog
Browse files Browse the repository at this point in the history
  • Loading branch information
dunningdan committed Jul 2, 2024
1 parent be60990 commit bbcee84
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 8 deletions.
25 changes: 25 additions & 0 deletions docs/configuring.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ Users may set Pixeebot preferences at either the organization or repository leve
2. **Organization-wide preferences:**
Alternatively, you can create the `pixeebot.yaml` file in the `.github` directory of your `.github` repository. This will serve as the global preferences that apply to all repositories in this installation.

## Codemod catalogs

Pixeebot offers three codemod catalogs to choose from in order to tune the type of improvements received.

- **Less**: Pixeebot will only suggest improvements for findings identified by a third-party security tool. See the [third-party security tools](/code-scanning-tools/overview) page for more information.
- **Moderate**: In addition to third-party security tool findings, Pixeebot will also suggest fixes for its own security findings.
- **More**: Includes everything from the Less and Moderate catalogs, along with additional suggestions Pixeebot identifies, such as style improvement and best practices.

### Selecting a catalog

During the onboarding process, users will be given the option to select a catalog preference for the organization they are installing on. This will determine the default catalog used for any repositories in that organization. If this step is skipped and no preference is selected, the Moderate catalog will be used by default. At any time, changes can be made by visiting the Pixee dashboard and selecting "View / change default preference" in the User menu.

Additionally, the catalog value can be configured on a per-repository/per-organization basis by updating the YAML configuration file. See the properties section below for more information.

## Properties

### `ai`
Expand All @@ -33,6 +47,17 @@ ai:
allow_llm_access: false
```
#### `catalog`

A string value that determines the codemod catalog used for code improvements. The value can be set to `less`, `moderate`, or `more`.

Example:

```yaml
codemods:
catalog: more
```

### `codemods`

Contains optional settings related to the codemod catalog Pixeebot uses to make changes to repositories.
Expand Down
8 changes: 0 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,6 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
announcementBar: {
id: "CLI_launch",
content:
'<b>🎉 Introducing the Pixee CLI.</b> Bring the power of Pixee\'s <a target="_blank" href="https://codemodder.io/">Codemodder framework</a> to your local development environment. <a target="_blank" href="https://github.com/pixee/pixee-cli">Learn more</a>',
backgroundColor: "fbfafb",
textColor: "1c1533",
isCloseable: true,
},
navbar: {
title: "Pixee",
logo: {
Expand Down

0 comments on commit bbcee84

Please sign in to comment.