Skip to content

Commit

Permalink
Merge pull request #42 from woocommerce/24-10/update/feature-check-in…
Browse files Browse the repository at this point in the history
…-validation-test

Add information on the feature check in the validation test
  • Loading branch information
singerb authored Oct 2, 2024
2 parents a042622 + fc36f3a commit 0fd0462
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/managed-tests/08-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
Our validation test is designed to inform you of any issues with plugin and theme metadata. Right now it is purely informative, but in the future it may block submissions or updates.

## Types of issues flagged

### Plugin headers

The presence or absence of certain headers will be checked; both the main plugin or theme file as well as the `readme.txt` will be checked, with priority given to the main file.

The following headers should be present, and will result in a warning if not:
Expand All @@ -17,6 +20,15 @@ The following headers should not be present when submitted, and will result in a

- `Woo` - as discussed [here](https://woocommerce.com/document/create-a-plugin/#section-14), this header will be added automatically during the deployment process; in order to avoid issues with incorrect headers or when distributing the same plugin outside the Marketplace, we recommend not including it manually.

### Woo feature compatibility

The plugin will be loaded along with WooCommerce and the WooCommerce features API will be used to check for declared incompatibility with the following features:

- `custom_order_tables` - also known as High Performance Order Storage (HPOS); this is now the default for new WooCommerce stores, and all extensions [should be compatible with it](https://developer.woocommerce.com/docs/hpos-extension-recipe-book/#2-supporting-high-performance-order-storage-in-your-extension).
- `cart_checkout_blocks` - extensions that modify the cart or checkout experience [should be compatible with this feature](https://developer.woocommerce.com/2023/11/06/faq-extending-cart-and-checkout-blocks/).

Because not all extensions are required to declare explicit compatibility for all features (i.e. an extension that does not modify the cart or checkout experience doesn't need to declare compatibility with the blocks feature), only an explicit declaration of incompatibility will be flagged as a warning.

## What to do if it fails

If your validation test is failing, please review the following steps:
Expand Down

0 comments on commit 0fd0462

Please sign in to comment.