An open API service indexing awesome lists of open source software.

https://github.com/godaddy-wordpress/sake

Our internal build tool for WP/WC plugins
https://github.com/godaddy-wordpress/sake

Last synced: about 1 year ago
JSON representation

Our internal build tool for WP/WC plugins

Awesome Lists containing this project

README

          

# 酒 SkyMake

#### SkyVerge WordPress and WooCommerce plugin build & deploy tool

Requires:
* node 8.9.4+
* [npx](https://www.npmjs.com/package/npx)

### Installation:

```
$ npm i skyverge/sake
```

### Update to latest

```
$ npm update skyverge/sake
```

> [!NOTE]
> Sake is currently not versioned, but a specific commit may be provided when installing, such as `skyverge/sake#0d5ec6622a6845f695d9e8ed04f4db08bd0e4986`.

> [!IMPORTANT]
> Refer to the [Setting up your environment](https://github.com/godaddy-wordpress/sake/wiki/Plugin-Deployment#setting-up-your-environment) section for the revised prerequisites, notably replacement of now-unused `WC_CONSUMER_KEY` and `WC_CONSUMER_SECRET` variables with new required `WC_USERNAME` and `WC_APPLICATION_PASSWORD` variables.

## Running tasks

Ensure you're in a plugin directory (ie `wc-plugins/woocommerce-address-validation`). Then type `npx sake {task}`, for example:

```
$ npx sake build
```

You can also [pass options](https://github.com/skyverge/sake/wiki/CLI-options) to tasks.

### See a list of available tasks

```
$ npx sake --tasks
```

## Developing

1. Make sure to read & understand [configuration](https://github.com/skyverge/sake/wiki/Configuration).
2. Use [Standard JS](https://standardjs.com/) coding style.
3. Test against forks of the development and production repos.