Skip to content

Automattic/gravatar-enhanced

Repository files navigation

Gravatar Enhanced

Banner

An enhanced version of Gravatar for WordPress.

Development

  • Clone this repo to the wp-content/plugins directory of a WordPress installation
  • composer install
  • yarn install
  • yarn build
  • Activate plugin
  • Configure plugin from the Settings > Discussion page

Sandboxes

If you wish to sync changes with a remote sandbox you add gravatar_enhanced to your ~/.npmrc file. The value should point to the remote directory (including host and username). The directory should have a trailing slash.

For example gravatar_enhanced=sandbox:public_html/wp-content/plugins/gravatar-enhanced/.

Building

The JS and CSS needs to be compiled. You can do this in development mode, which will monitor for updates to the files:

yarn start

If you want to build production files (minified and without debugging) then:

yarn build

Releasing

Please update the following information in the relevant files before releasing:

A release packages up all the JS, CSS, and PHP files into a clean directory without any development tooling.

yarn release

The plugin will be available in the release directory.

You can sync to a remote sandbox with (see sandbox configuration above):

yarn release:sync

Distribution

To produce a released and versioned distribution of the plugin run:

yarn dist:github

This will produce a zip file, upload it to Github, and mark it as an official release.

You can sync this to the WordPress.org SVN repo with:

yarn dist:svn

You will need appropriate permissions.

Using the WordPress.org plugin

Through the magic of WordPress Playground you can use the released plugin in WordPress.org by clicking this link:

Open and use WordPress with Gravatar Enhanced

You can use yarn blueprint to generate this URL.