Skip to content

Commit 22db733

Browse files
authored
Merge pull request #58 from woocommerce/25-02/add/extension-sets
Basic docs on extension sets.
2 parents efc4590 + 92af147 commit 22db733

File tree

4 files changed

+47
-1
lines changed

4 files changed

+47
-1
lines changed

docs/managed-tests/activation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ Replace `your-extension` with the slug of your plugin.
8080

8181
Some plugins might need an actual live site URL to work properly, such as payment gateways and SaaS. For those, you can use our [built-in tunnel feature](../environment/tunnel.md) to test these plugins.
8282

83+
## Canonical compatibility check in the WooCommerce Marketplace
84+
85+
The WooCommerce Marketplace will automatically run an activation test using the [`compatibility` extension set](extension-sets) upon new submission or update. You will see the results in the list of tests under `Activation (canonical compatibility check)`. Currently this test is informational only, and will not block a submission or an update.
86+
8387
## What to do if it fails
8488

8589
If your Activation test fails:

docs/managed-tests/extension-sets.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Extension sets
2+
3+
Extension sets provide a way to run certain managed test types with a predefined set of other extensions included in the environment. This allows for standardized compatibility testing, as well as testing in environments closer to a production WooCommerce store.
4+
5+
## Compatible test types
6+
7+
Extension sets can be utilized with [Woo E2E](woo-e2e), [Woo API](woo-api), and [Activation](activation) tests currently.
8+
9+
## Available extension sets
10+
11+
`compatibility` is the only extension set available in production right now. It's designed to contain a selection of typical WooCommerce extensions, including many official extensions:
12+
- [Gift Cards](https://woocommerce.com/products/gift-cards/)
13+
- [WooCommerce Product Add-Ons](https://woocommerce.com/products/product-add-ons/)
14+
- [WooCommerce Min/Max Quantities](https://woocommerce.com/products/min-max-quantities/)
15+
- [WooCommerce Product Bundles](https://woocommerce.com/products/product-bundles/)
16+
- [WooCommerce Product Recommendations](https://woocommerce.com/products/product-recommendations/)
17+
- [WooCommerce Payments](https://woocommerce.com/products/woocommerce-payments/)
18+
- [AutomateWoo](https://woocommerce.com/products/automatewoo/)
19+
- [WooCommerce Shipping](https://woocommerce.com/products/shipping/)
20+
- [WooCommerce Subscriptions](https://woocommerce.com/products/woocommerce-subscriptions/)
21+
- [WooCommerce Composite Products](https://woocommerce.com/products/composite-products/)
22+
- [WooCommerce Tax](https://woocommerce.com/products/tax/)
23+
- [WooCommerce Google Analytics Integration](https://wordpress.org/plugins/woocommerce-google-analytics-integration/)
24+
- [MailPoet](https://wordpress.org/plugins/mailpoet/)
25+
- [Jetpack](https://wordpress.org/plugins/jetpack/)
26+
27+
## Running tests with an extension set
28+
29+
All test types that support extension sets support an `--extension_set` argument to the QIT CLI to specify a set to include.
30+
31+
## The WooCommerce Marketplace and extension sets
32+
33+
Currently the WooCommerce Marketplace will automatically run an Activation test using the `compatibility` extension set upon new submission or update. You will see the results in the list of tests under `Activation (canonical compatibility check)`. Currently this test is informational only, and will not block a submission or an update.

docs/support/test-options.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ When running tests with QIT, you can specify various options—like WordPress, W
1212
| PHP Version ||||||||
1313
| Additional Extensions ||||||||
1414
| Additional WordPress Plugins ||||||||
15+
| [Extension sets](../managed-tests/extension-sets) ||||||||
1516

1617
**Key:**
1718
- ✅: Option supported by that test type.
@@ -55,6 +56,13 @@ qit run:activation my-extension --plugin=woocommerce --plugin=my-other-plugin
5556

5657
This ensures compatibility and stable interactions within a controlled environment.
5758

59+
## Extension sets
60+
61+
```qitbash
62+
qit run:woo-api my-extension --extension_set=compatibility
63+
```
64+
Extension sets provide a way to run certain managed test types with a predefined set of other extensions included in the environment. For more information see [their documentation page](../managed-tests/extension-sets).
65+
5866
## Configuring test options in config files
5967

6068
Instead of passing flags every time, define options in `qit.yml` or `qit.json`:

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ const sidebars = {
5454
'managed-tests/malware',
5555
'managed-tests/validation',
5656
'managed-tests/plugin-check',
57+
'managed-tests/extension-sets',
5758
],
5859
},
5960
{
@@ -121,4 +122,4 @@ const sidebars = {
121122
],
122123
};
123124

124-
export default sidebars;
125+
export default sidebars;

0 commit comments

Comments
 (0)