Search by

woocommerce / extension-changelogger

woocommerce

Jetpack Changelogger formatter for the WooCommerce extension changelog format

Package info

github.com/woocommerce/extension-changelogger

pkg:composer/woocommerce/extension-changelogger

Statistics

Installs: 1 600

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.1.0 2026-11-19 15:12 UTC

This package is auto-updated.

Last update: 2026-11-19 15:13:34 UTC


README

woocommerce/extension-changelogger formats the changelog.txt used by WooCommerce extensions. It works with Jetpack Changelogger 6 and PHP 7.4 or later. Install it from the extension root:

composer require --dev woocommerce/extension-changelogger:^1.0

Set extra.changelogger.formatter.class to Automattic\WooCommerce\ExtensionTools\Changelogger\Changelog_Formatter. Keep the plugin's title under extra.changelogger.formatter.title and its change types, entry ordering and versioning under extra.changelogger. Use the extension's existing Changelogger commands to validate change files and compile releases.

PHPUnit bootstrap

With version 1.1.0 or later, use Automattic\WooCommerce\ExtensionTools\Testing\Test_Bootstrap in an extension's PHPUnit bootstrap after loading Composer's autoloader.

  • Call Test_Bootstrap::load_core_test_cases( $wc_tests_dir ) where the suite loads WooCommerce's wp-http-testcase.php and class-wc-unit-test-case.php in that order. Pass the path to WooCommerce's legacy tests directory and load any additional test classes in the suite.
  • Call Test_Bootstrap::initialize_test_container() once, when the suite finishes loading WooCommerce and its test tools. By default it wraps the inner container in TestingContainer. Pass true in suites that already replace the legacy proxy on the inner container when service replacement and reset are available. The helper leaves the container alone if WooCommerce uses a different container layout.

Test with a local checkout

To rehearse unpublished changes, add a Composer path repository to the extension's root composer.json. Use a distinct development version and adjust the path to your WooCommerce checkout.

{
	"repositories": [
		{
			"type": "path",
			"url": "../woocommerce/packages/php/extension-tooling",
			"options": {
				"versions": { "woocommerce/extension-changelogger": "dev-local" }
			}
		}
	],
	"require-dev": { "woocommerce/extension-changelogger": "dev-local" }
}

From the extension root, run composer update woocommerce/extension-changelogger to install the package and update the extension's lockfile for the rehearsal.

Run composer install and composer test from this directory to test the formatter itself.