Skip to content

INSTALLATION.md

Latest commit

 

History

History
39 lines (26 loc) · 1.04 KB

INSTALLATION.md

File metadata and controls

39 lines (26 loc) · 1.04 KB
Raw

Installation

Requirements

  • PHP >= 8.1 and < 8.6
  • Composer 2.x
  • Git

Composer

Add the package as a development dependency:

composer require --dev nowo-tech/code-review-guardian

After installation, the Composer plugin copies framework-specific configuration, the code-review-guardian.sh entry script, and documentation files into your project. See USAGE.md for how to run the guardian.

Wrapper script updates

code-review-guardian.sh is installed when it does not exist. If you already have a local copy that differs from the package version, the plugin keeps your file and prints a warning.

To allow the plugin to overwrite the wrapper on every install/update, add to your project's composer.json:

{
  "extra": {
    "code-review-guardian": {
      "auto_update_wrapper": true
    }
  }
}

See UPGRADING.md for the 1.1.0 behavior change.

Token for Git providers

Configure a Git provider API token (for example in .env) as described in TOKEN_SETUP.md.