Skip to content

woocommerce/code-reference

Repository files navigation

WooCommerce Code Reference Generator

Generate WooCommerce Code Reference.

Install

git clone https://github.com/woocommerce/code-reference.git

Usage

cd code-reference
./deploy.sh -s <VERSION>

Options

Options Description
-h or --help Show help information.
-v or --verbose Increase verbosity. Useful for debugging.
-s <VERSION> or --source-version <VERSION> Source version to build and deploy.
-r <GITHUB_REPO> or --github-repo <GITHUB_REPO> GitHub repo with username, default to "woocommerce/woocommerce".
-e or --allow-empty Allow deployment of an empty directory.
-m <MESSAGE> or --message <MESSAGE> Specify the message used when committing on the deploy branch.
-n or --no-hash Don't append the source commit's hash to the deploy commit's message.
--build-only Only build but not push.
--push-only Only push but not build.
--no-download Skip zip download in case there's on in the project's root.

Changelog

See changelog for details