# wp-release: docs

Build, check and ship a plugin release: production zip, Plugin Check, wordpress.org SVN deploy.

Generated from wp-release at release v1.0.1.

## Install

```bash
composer require mammothwp/wp-release --dev
```

## Usage snippets

### Install

```bash
composer require --dev mammothwp/wp-release
vendor/bin/mmwp-release --help
```

### Configuration

```json
{
  "slug": "my-plugin",
  "php_min": "7.4",
  "wp_version": "6.8",
  "strict": false,
  "allow": [],
  "excludes": ["*.psd", "docs/*"],
  "github_repo": "my-plugin"
}
```

### Local usage (DDEV or any local PHP)

```bash
ddev composer require --dev mammothwp/wp-release
ddev exec vendor/bin/mmwp-release build
ddev exec vendor/bin/mmwp-release check            # add --strict, --self-test, --keep
ddev exec vendor/bin/mmwp-release status
ddev exec vendor/bin/mmwp-release deploy-wporg --dry-run
```

## In these docs

- [Command line](https://mammothwp.com/docs/wp-release/cli/)
- [Use cases](https://mammothwp.com/docs/wp-release/use-cases/)