Add Compat Checker library for versioning and compatibility checks

.github/workflows/github-action-publish-compat-checker.yml

@@ -0,0 +1,20 @@
+name: Publish Compat Checker package
+on:
+  push:
+    branches:
+      - trunk
+
+jobs:
+  deploy:
+    name: Publish Compat Checker package
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Deploy
+      uses: s0/git-publish-subdir-action@develop
+      env:
+        REPO: self
+        BRANCH: compat-checker
+        FOLDER: packages/php/compat-checker
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -6,3 +6,6 @@ vendor/
 
 # All zip files
 *.zip
+
+# IDE files
+.vscode/*

README.md

@@ -11,6 +11,7 @@ The packages here are too experimental or too Grow-specific to be shared Woo-wid
 - [`/packages/js/generator-grow`](packages/js/generator-grow/README.md) - Yeoman Generator for extension repository boilerplate.
 - [`/packages/js/storybook`](packages/js/storybook/README.md) - Storybook dependencies and basic scripts
 - [`/packages/js/tracking-jsdoc`](packages/js/tracking-jsdoc/README.md) - `jsdoc` plugin to document Tracking Events in markdown
+- [`/packages/php/compat-checker`](packages/php/compat-checker/README.md) - Library to run compatibility checks for WooCommerce extensions.
 
 ## List of plugins
 

packages/php/compat-checker/README.md

@@ -0,0 +1,42 @@
+# Compat Checker for WooCommerce Extensions
+
+A simple library to run compatibility checks for WooCommerce extensions.
+
+## Getting Started
+
+1. Include this library in your WooCommerce plugin's `composer.json` like shown below:
+
+```json
+{
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/woocommerce/grow"
+        }
+    ],
+    "require": {
+        "woocommerce/grow": "dev-compat-checker"
+    }
+}
+```
+2. Run `composer update` to include the `woocommerce/grow` repo in the `vendor` folder.
+
+3. In the main plugin file that contains the plugin header, add the compatibility check like the below example:
+
+```php
+require __DIR__ . '/vendor/autoload.php';
+
+use Automattic\WooCommerce\Grow\Tools\CompatChecker\v0_0_1\Checker;
+
+add_action( 'plugins_loaded', 'wc_plugin_init' );
+
+function wc_plugin_init() {
+    define( 'WC_BRANDS_VERSION', '1.6.56' ); // WRCS: DEFINED_VERSION.
+
+    if ( ! Checker::instance()->is_compatible( __FILE__, WC_BRANDS_VERSION ) ) {
+		return;
+	}
+
+    // Continue initializing the plugin.
+}
+```

packages/php/compat-checker/composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "woogrow/compat-checker",
+    "description": "Compatibility checker for Woo Grow extensions",
+    "version": "0.0.1",
+    "license": "GPL-3.0",
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "autoload": {
+        "psr-4": {
+            "Automattic\\WooCommerce\\Grow\\Tools\\CompatChecker\\v0_0_1\\": "src/"
+        }
+    },
+    "require-dev": {
+        "woocommerce/woocommerce-sniffs": "^0.1.3"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    }
+}