Skip to content

Add excluded files documentation for code review and changes #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2025
Merged

Add excluded files documentation for code review and changes #683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 78 additions & 1 deletion docs/automation-actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,45 @@ GUIDELINES: |

```

The following files are automatically excluded from the code review.

| File type | Filter type | Values|
| - | - | - |
| Data | Extension | `ini` `csv` `xls` `xlsx` `xlr` `doc` `docx` `txt` `pps` `ppt` `pptx` `dot` `dotx` `log` `tar` `rtf` `dat` `ipynb` `po` `profile` `object` `obj` `dxf` `twb` `bcsymbolmap` `tfstate` `pdf` `rbi` `pem` `crt` `svg` `png` `jpeg` `jpg` `ttf` |
| Data | Regex | `.*dist/.*\.js$` `.*public/assets/.*\.js$` |
| Pipeline | Regex | `.*ci\.yml$` |

| Lock File Name | Programming Language | Package Manager |
|-------------------------|----------------------|----------------------|
| `package-lock.json` | JavaScript | npm |
| `yarn.lock` | JavaScript | Yarn |
| `npm-shrinkwrap.json` | JavaScript | npm |
| `Pipfile.lock` | Python | pipenv |
| `poetry.lock` | Python | Poetry |
| `conda-lock.yml` | Python | conda |
| `Gemfile.lock` | Ruby | Bundler |
| `composer.lock` | PHP | Composer |
| `packages.lock.json` | .NET | NuGet |
| `project.assets.json` | .NET | .NET Core |
| `pom.xml` | Java | Maven |
| `Cargo.lock` | Rust | Cargo |
| `mix.lock` | Elixir | Mix |
| `pubspec.lock` | Dart/Flutter | pub |
| `go.sum` | Go | Go modules |
| `stack.yaml.lock` | Haskell | Stack |
| `vcpkg.json` | C++ | vcpkg |
| `conan.lock` | C++ | Conan |
| `ivy.xml` | Scala | sbt/Ivy |
| `project.clj` | Clojure | Leiningen |
| `Podfile.lock` | Swift/Objective-C | CocoaPods |
| `Cartfile.resolved` | Swift/Objective-C | Carthage |
| `flake.lock` | Nix | Nix |
| `pnpm-lock.yaml` | JavaScript | pnpm |

!!! tip

You can also filter more files, using [`config.ignore_files`](/cm-file/#configignore_files).

#### `describe-changes` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:

This action, once triggered, leverages AI to generate a comprehensive summary of the changes in the PR and incorporates it into the PR description.
Expand Down Expand Up @@ -360,9 +399,47 @@ GUIDELINES: |

# Load the PR template content from a file in the repository
TEMPLATE: {{ ".github/PULL_REQUEST_TEMPLATE.md" | readFile() | dump }}

```

The following files are automatically excluded from the describe changes.

| File type | Filter type | Values|
| - | - | - |
| Data | Extension | `ini` `csv` `xls` `xlsx` `xlr` `doc` `docx` `txt` `pps` `ppt` `pptx` `dot` `dotx` `log` `tar` `rtf` `dat` `ipynb` `po` `profile` `object` `obj` `dxf` `twb` `bcsymbolmap` `tfstate` `pdf` `rbi` `pem` `crt` `svg` `png` `jpeg` `jpg` `ttf` |
| Data | Regex | `.*dist/.*\.js$` `.*public/assets/.*\.js$` |
| Pipeline | Regex | `.*ci\.yml$` |

| Lock File Name | Programming Language | Package Manager |
|-------------------------|----------------------|----------------------|
| `package-lock.json` | JavaScript | npm |
| `yarn.lock` | JavaScript | Yarn |
| `npm-shrinkwrap.json` | JavaScript | npm |
| `Pipfile.lock` | Python | pipenv |
| `poetry.lock` | Python | Poetry |
| `conda-lock.yml` | Python | conda |
| `Gemfile.lock` | Ruby | Bundler |
| `composer.lock` | PHP | Composer |
| `packages.lock.json` | .NET | NuGet |
| `project.assets.json` | .NET | .NET Core |
| `pom.xml` | Java | Maven |
| `Cargo.lock` | Rust | Cargo |
| `mix.lock` | Elixir | Mix |
| `pubspec.lock` | Dart/Flutter | pub |
| `go.sum` | Go | Go modules |
| `stack.yaml.lock` | Haskell | Stack |
| `vcpkg.json` | C++ | vcpkg |
| `conan.lock` | C++ | Conan |
| `ivy.xml` | Scala | sbt/Ivy |
| `project.clj` | Clojure | Leiningen |
| `Podfile.lock` | Swift/Objective-C | CocoaPods |
| `Cartfile.resolved` | Swift/Objective-C | Carthage |
| `flake.lock` | Nix | Nix |
| `pnpm-lock.yaml` | JavaScript | pnpm |

!!! tip

You can also filter more files, using [`config.ignore_files`](/cm-file/#configignore_files).

#### `explain-code-experts` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:

This action, shall add a comment with codeExperts suggestion. If the comment already exists, the comment shall be edited.
Expand Down