Repository files navigation

semantic-release plugin to create a zip file for aWordPress plugin or theme.

$ npm install -D @semantic-release/wordpress

The plugin can be configured in thesemantic-release configuration file:

{"plugins": ["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator",    ["@semantic-release/wordpress", {"type":"plugin","slug" :"my-plugin","withAssets":true,"withReadme":true,"withVersionFile":true,    }]  ]}

With this example, for each release, the plugin will:

• Verify that the plugin is valid
• Create a zip file for the plugin (/tmp/wp-release/my-plugin.zip)
• Create a zip file for the assets (/tmp/wp-release/assets.zip)
• Copy the readme.txt file (/tmp/wp-release/readme.txt)
• Create a version file (/tmp/wp-release/version.txt)

Plugin uses no environment variables, but has a lot of configuration options

Plugin will automatically replace versions in your main file (for plugins) and thestyle.css file (for themes).We follow the WordPress codex, so your plugin file must have the same slug as the plugin folder.

If you have other variables which need to have the version replaced, you can add them to theversionFiles option.

If you need any further processing of the package files, next release version will be output to/tmp/wp-release/VERSION file, if thewithVersionFile option is set totrue.

If your package is onwp.org repository, you might have assets (screenshots, banners, logos) which you want to include in the assets file. Plugin respects the Codex, and expects those to be in.wordpress-org/assets folder. Main theme screenshot should be namedscreenshot and should be there as well.

readme.txt is a special Markdown file needed for packages onwp.org to work. It can be in the.wordpress-org folder, or in the repository root.
Plugin will automatically replace the version in the file if thewithReadme option is set totrue.

By default, plugin will include all files in the package zip file. If you want to exclude some files, you can use theexclude option. It accepts an array of files and folders, and usesglob for path resolution.You can also use theinclude option which works in the same manner.

• Include and exclude options are not mutually exclusive so you can use both.
• Plugin also looks for.distinclude and.distexclude /.distignore files which take precedence over the options set in the plugin.
• By default we exclude a lot of build artifacts and files which are not needed in the package. You can see the full list inconstants.ts.

Plugin with assets, readme and additional version files

{"plugins": [    ["@semantic-release/wordpress", {"type":"plugin","slug" :"my-plugin","withAssets":true,"withReadme":true,"withVersionFile":false,"versionFiles": ["constants.php","includes/db-schema.php"      ]    }]  ]}