wp-deployer

Deploy WordPress plugin and theme to the WordPress.org plugin and theme directories.

Install

Requires Node 22 or later.

npm install --save-dev wp-deployer

Usage

Run from your project root (the directory that contains package.json with your wpDeployer config):

npx wp-deployer

CLI sub-commands:

npx wp-deployer --help
npx wp-deployer --version
npx wp-deployer --assets
npx wp-deployer --dry-run

Use --assets when you only want to push the assets directory (e.g. screenshots, banner) to WordPress.org and skip trunk and tag deployment.

Use --dry-run to run checkout, clear/copy, and local svn add / svn delete preparation only. No svn commit or remote tag copy runs, so nothing is pushed—useful to inspect the working copy before a real deploy.

Or add a script to package.json and run it:

npm run wpdeploy

SVN authentication

wp-deployer is intended for deploying from your own computer to WordPress.org SVN. It does not store or read an SVN password.

• username in wpDeployer is passed to svn as --username only.
• Passwords are handled entirely by your Subversion client (prompt in the terminal and/or the OS keychain / SVN credential cache, depending on your setup).
• The first time you deploy (or after credentials expire), SVN may ask for your password. Later runs often do not prompt, because SVN reuses cached credentials—that is normal and secure on a personal machine.
• Follow WordPress.org’s current documentation for account access.

On a shared computer, review SVN’s credential storage and clear saved auth when you are done if needed.

Settings

• slug : Plugin or theme slug; Default: name value in package.json
• username : WordPress repository username; This is required.
• repoType: Repo type; plugin or theme; Default: plugin.
• buildDir: The directory where your theme or plugin exists as you want it on the repo. Default: dist
• deployTrunk: Whether to deploy to trunk. This could be set to false to only commit the assets directory. Applies for plugin only; Default: true
• deployTag: Whether to create a tag for this version from trunk after a trunk deploy. Set to false to skip tagging. If true, deployTrunk must also be true (tag-only deploys are not supported). Applies for plugin only; Default: true
• deployAssets: Whether to deploy assets. Applies for plugin only; Default: false
• assetsDir: The directory where your plugins assets are kept; Default: .wordpress-org
• tmpDir: Parent directory for the SVN working copy (slug is appended). Default: system temp directory from os.tmpdir() (not hard-coded /tmp).
• earlierVersion: Last released version. Applies for theme only; This is required if repoType is theme.

Example

Deploy plugin

In package.json:

...
"wpDeployer": {
  "username": "yourusername",
  "buildDir": "dist"
},
...
"scripts": {
  ...
  "wpdeploy": "wp-deployer"
}

Deploy theme

In package.json:

...
"wpDeployer": {
  "repoType": "theme", // This is required
  "earlierVersion": "1.0.2", // Required; Keep last released version
  "username": "yourusername",
  "buildDir": "dist"
},
...
"scripts": {
  ...
  "wpdeploy": "wp-deployer"
}

License

MIT