Skip to content

Commit

Permalink
Remove references to configuring preferences in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@iulspop
iulspop committed Jan 28, 2025
1 parent c0ebd80 commit f443943
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 256 deletions.
248 changes: 0 additions & 248 deletions docs/configuring.md
View file
Original file line number Diff line number Diff line change
@@ -1,248 +0,0 @@
---
sidebar_position: 3
---

# Preferences

Pixee works immediately after installation without any further configuration. Yet, Pixee exposes preferences for users to tailor its behavior when desirable.

Users may set Pixee preferences at either the organization or repository levels.

1. **Repository preferences:**
Create a `pixeebot.yaml` file in the `.github` directory of the target repository. Preferences in the target repository will take precedence over other preferences.

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.

## Properties

### `ai`

Contains settings related to AI functionality.

#### `allow_llm_access`

`true` by default.

Setting to `false` disables Pixee features that [rely on generative AI](faqs.md) to analyze your code.

Example:

```yaml
ai:
allow_llm_access: false
```
### `codemods`

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

#### `exclude`

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

Example:

```yaml
codemods:
exclude:
- pixee:python/https-connection
```

#### `prepend`

A list of non-default codemods to prepend to the codemod catalog. This list is
ordinal: the continuous improvement campaign will execute the codemods in the
order given.

Example:

```yaml
codemods:
prepend:
- pixee:python/use-walrus-if
```

### `paths`

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

#### `exclude`

A set of paths to files or directories to exclude from Pixee 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 Pixee 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).

To automatically assign **users** to Pixee PRs, consider creating a GitHub action. Below is an example action that will assign all Pixee PRs to the user Octocat:

```yaml
on:
pull_request:
types: [opened, reopened, ready_for_review]
jobs:
auto-assign:
runs-on: ubuntu-latest
if: github.actor == 'pixeebot[bot]'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Assign PR to Collaborators
uses: actions/github-script@v7
with:
script: |
const collaborators = ['octocat']; // Replace with actual GitHub usernames
github.rest.issues.addAssignees({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
assignees: collaborators
})
```

Please contact us at [email protected] with any questions, or if you would like more options for automatic assignment.

## Configuring Automatic Formatting

Many projects enforce a consistent code style by using automatic code formatters. This section contains instructions for configuring GitHub Actions to automatically format PRs that are created by Pixee.

### Python

The most popular Python code formatter is [Black](https://black.readthedocs.io/en/stable/). To automatically format PRs created by Pixee using Black, add the following GitHub action workflow to your repository:

```yaml
name: Format Pixeebot PRs
on:
pull_request:
types: [opened, synchronize]
jobs:
apply-black:
if: github.event.pull_request.user.login == 'pixeebot[bot]'
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install black
run: pip install black
- name: Apply black formatting
run: black .
- name: Commit and push changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: ":art: Apply formatting"
```

This action can be added to your repository by creating a `.github/workflows/pixeebot-autoformat-black.yml` file with the above content.

Note that it may be necessary to pin the version of Black to ensure that the formatting is consistent with your project's style. Depending on your project's configuration it may also be necessary to pass additional arguments to the `black` command to ensure that the correct settings are used.

### Java

For Java projects it is common to use a tool such as [Spotless](https://github.com/diffplug/spotless) to enforce code formatting. To automatically format PRs created by Pixee using Gradle to apply Spotless, add the following GitHub action workflow to your repository:

```yaml
name: Format Pixeebot PRs
on:
pull_request:
types: [opened, synchronize]
jobs:
spotless-apply:
if: github.event.pull_request.user.login == 'pixeebot[bot]'
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: "Setup JDK"
uses: actions/setup-java@v4
with:
distribution: "temurin"
java-version: "17"
- name: 🐘Setup Gradle
uses: gradle/actions/setup-gradle@v3
- name: 🎨 Run spotless via Gradle
run: ./gradlew spotlessApply
- name: Commit and push changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: ":art: Apply formatting"
```

## Configuring Lockfile Updates

Some Pixee fixes add dependencies to your project. For package managers that rely on lockfiles, it is important to update the lockfile after adding dependencies. We recommend using a GitHub Action to automatically update lockfiles for Pixee PRs.

### Python: Poetry

[Poetry](https://python-poetry.org/) is a popular Python package manager that uses a `pyproject.toml` file to manage dependencies. To automatically update the Poetry lockfile for Pixee PRs that add dependencies, add the following GitHub action workflow to your repository:

```yaml
name: Update Poetry Lockfile
on:
pull_request:
paths:
- "pyproject.toml"
jobs:
update-lock-file:
if: github.event.pull_request.user.login == 'pixeebot[bot]'
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11" # Specify your Python version here
- name: Install Poetry
run: pip install poetry
- name: Generate lock file
run: poetry update
- name: Commit and push changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: ":lock: Update Poetry lock file"
```
6 changes: 0 additions & 6 deletions docs/faqs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ We utilize Large Language Models (LLMs) in some context-aware code fixes and to

At Pixee, we take your data privacy and security seriously. We want you to have peace of mind, knowing that your data will never be used to train AI models.

By default, we enable the use of Large Language Models (LLMs) for an enhanced user experience. However, if you prefer not to use them, you can easily [disable](configuring.md) this feature at your convenience. We believe in providing you with the flexibility to tailor your experience according to your preferences and needs.

### How does Pixee handle my data?

Pixee is a platform focused on helping developers deliver higher quality code and places the utmost importance on our own security, including secure software development practices, IT practices, corporate controls and partner assessments. In case anyone asks, yes -- all data is encrypted in transit and at rest, and guaranteed to be destroyed.
Expand All @@ -32,10 +30,6 @@ Pixee works directly with your repositories through pull/merge requests, so you

Some "shapes" of vulnerable code may not be fixable in a safe way, or recognized by our remediation logic. Please file a ticket if this happens and you think we should fix it! Providing an anonymized code sample and security finding will help us a lot.

### How can I apply automatic formatting to PRs generated by Pixee?

See our [Preferences](configuring.md#configuring-automatic-formatting) page for more information on how to enable automatic formatting of PRs generated by Pixee.

### Where can I learn more and discuss Pixee?

Users can join the Pixee community [on Slack](https://join.slack.com/t/openpixee/shared_invite/zt-1pnk7jqdd-kfwilrfG7Ov4M8rorfOnUA). This channel can be used to engage with peers who are also interested in Pixee. Feel free to email us at [email protected] with any questions or comments.
Expand Down
2 changes: 0 additions & 2 deletions docs/installing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ We provide a free tier offering that can be installed on any public or private r

To try Pixee, visit our [GitHub App page](https://github.com/apps/pixeebot/). From there, click **Install** (or **Configure**) and follow the prompts from GitHub. You'll be directed to your Pixee dashboard once the installation process is complete.

See the [Preferences](/configuring) page for information on how to configure Pixee to suit your needs.

## Self-Hosted

Pixee offers a self-hosted Pixee Enterprise Server for organizations that require additional security or compliance measures. To learn more about Pixee self-hosted solutions, please [contact us](https://pixee.ai/demo-landing-page).
Expand Down

0 comments on commit f443943

Please sign in to comment.