Skip to content

Commit c7ff66c

Browse files
committed
Add excluded files documentation for code review and changes
1 parent 26b2175 commit c7ff66c

File tree

1 file changed

+78
-1
lines changed

1 file changed

+78
-1
lines changed

docs/automation-actions.md

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,45 @@ GUIDELINES: |
314314
315315
```
316316

317+
The following files are automatically excluded from the code review.
318+
319+
| File type | Filter type | Values|
320+
| - | - | - |
321+
| 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` |
322+
| Data | Regex | `.*dist/.*\.js$` `.*public/assets/.*\.js$` |
323+
| Pipeline | Regex | `.*ci\.yml$` |
324+
325+
| Lock File Name | Programming Language | Package Manager |
326+
|-------------------------|----------------------|----------------------|
327+
| `package-lock.json` | JavaScript | npm |
328+
| `yarn.lock` | JavaScript | Yarn |
329+
| `npm-shrinkwrap.json` | JavaScript | npm |
330+
| `Pipfile.lock` | Python | pipenv |
331+
| `poetry.lock` | Python | Poetry |
332+
| `conda-lock.yml` | Python | conda |
333+
| `Gemfile.lock` | Ruby | Bundler |
334+
| `composer.lock` | PHP | Composer |
335+
| `packages.lock.json` | .NET | NuGet |
336+
| `project.assets.json` | .NET | .NET Core |
337+
| `pom.xml` | Java | Maven |
338+
| `Cargo.lock` | Rust | Cargo |
339+
| `mix.lock` | Elixir | Mix |
340+
| `pubspec.lock` | Dart/Flutter | pub |
341+
| `go.sum` | Go | Go modules |
342+
| `stack.yaml.lock` | Haskell | Stack |
343+
| `vcpkg.json` | C++ | vcpkg |
344+
| `conan.lock` | C++ | Conan |
345+
| `ivy.xml` | Scala | sbt/Ivy |
346+
| `project.clj` | Clojure | Leiningen |
347+
| `Podfile.lock` | Swift/Objective-C | CocoaPods |
348+
| `Cartfile.resolved` | Swift/Objective-C | Carthage |
349+
| `flake.lock` | Nix | Nix |
350+
| `pnpm-lock.yaml` | JavaScript | pnpm |
351+
352+
!!! tip
353+
354+
You can also filter more files, using [`config.ignore_files`](/cm-file/#configignore_files).
355+
317356
#### `describe-changes` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
318357

319358
This action, once triggered, leverages AI to generate a comprehensive summary of the changes in the PR and incorporates it into the PR description.
@@ -360,9 +399,47 @@ GUIDELINES: |
360399
361400
# Load the PR template content from a file in the repository
362401
TEMPLATE: {{ ".github/PULL_REQUEST_TEMPLATE.md" | readFile() | dump }}
363-
364402
```
365403

404+
The following files are automatically excluded from the describe changes.
405+
406+
| File type | Filter type | Values|
407+
| - | - | - |
408+
| 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` |
409+
| Data | Regex | `.*dist/.*\.js$` `.*public/assets/.*\.js$` |
410+
| Pipeline | Regex | `.*ci\.yml$` |
411+
412+
| Lock File Name | Programming Language | Package Manager |
413+
|-------------------------|----------------------|----------------------|
414+
| `package-lock.json` | JavaScript | npm |
415+
| `yarn.lock` | JavaScript | Yarn |
416+
| `npm-shrinkwrap.json` | JavaScript | npm |
417+
| `Pipfile.lock` | Python | pipenv |
418+
| `poetry.lock` | Python | Poetry |
419+
| `conda-lock.yml` | Python | conda |
420+
| `Gemfile.lock` | Ruby | Bundler |
421+
| `composer.lock` | PHP | Composer |
422+
| `packages.lock.json` | .NET | NuGet |
423+
| `project.assets.json` | .NET | .NET Core |
424+
| `pom.xml` | Java | Maven |
425+
| `Cargo.lock` | Rust | Cargo |
426+
| `mix.lock` | Elixir | Mix |
427+
| `pubspec.lock` | Dart/Flutter | pub |
428+
| `go.sum` | Go | Go modules |
429+
| `stack.yaml.lock` | Haskell | Stack |
430+
| `vcpkg.json` | C++ | vcpkg |
431+
| `conan.lock` | C++ | Conan |
432+
| `ivy.xml` | Scala | sbt/Ivy |
433+
| `project.clj` | Clojure | Leiningen |
434+
| `Podfile.lock` | Swift/Objective-C | CocoaPods |
435+
| `Cartfile.resolved` | Swift/Objective-C | Carthage |
436+
| `flake.lock` | Nix | Nix |
437+
| `pnpm-lock.yaml` | JavaScript | pnpm |
438+
439+
!!! tip
440+
441+
You can also filter more files, using [`config.ignore_files`](/cm-file/#configignore_files).
442+
366443
#### `explain-code-experts` :fontawesome-brands-github: :fontawesome-brands-gitlab: :fontawesome-brands-bitbucket:
367444

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

0 commit comments

Comments
 (0)