From c7ff66c24023683ab464c48dd480f25476957c86 Mon Sep 17 00:00:00 2001 From: Ofer Affias Date: Wed, 9 Apr 2025 16:16:26 +0300 Subject: [PATCH] Add excluded files documentation for code review and changes --- docs/automation-actions.md | 79 +++++++++++++++++++++++++++++++++++++- 1 file changed, 78 insertions(+), 1 deletion(-) diff --git a/docs/automation-actions.md b/docs/automation-actions.md index 9289d1674..8c45f1c5a 100644 --- a/docs/automation-actions.md +++ b/docs/automation-actions.md @@ -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. @@ -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.