Skip to content

Commit

Permalink
Merge pull request #40 from woocommerce/24-09/update/validation-test-…
Browse files Browse the repository at this point in the history
…additions

Update validation docs for new headers and include more explanation
  • Loading branch information
singerb authored Sep 19, 2024
2 parents 796a5b3 + de53164 commit a042622
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
19 changes: 14 additions & 5 deletions docs/managed-tests/08-validation.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Validation Tests
# Validation tests

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
The presence and value of certain headers will be checked:
## Types of issues flagged
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.

- `Requires PHP` - warning if not present in main plugin or theme file.
- More coming soon!
The following headers should be present, and will result in a warning if not:

- `Requires PHP` - so that users know if your extension requires a specific version of PHP.
- `Requires at least` - so that users know if your extension requires a specific version of WordPress.
- `Tested up to` - so users can be sure that your extension works correctly with recent WordPress versions.
- `WC requires at least` - so that users know if your extension requires a specific version of WooCommerce.
- `WC tested up to` - so users can be sure that your extension works correctly with recent WooCommerce versions.

The following headers should not be present when submitted, and will result in a warning if they are:

- `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.

## What to do if it fails

Expand Down
2 changes: 1 addition & 1 deletion src/components/TestTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export default function TestTypes({ includeCode = false }) {
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:phpcompatibility</code></li>
<li><a href="/docs/managed-tests/malware">Malware tests</a> <code
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:malware</code></li>
<li><a href="/docs/managed-tests/validation">Validation Tests</a> <code
<li><a href="/docs/managed-tests/validation">Validation tests</a> <code
style={{ display: includeCode ? 'inline-block' : 'none' }}>run:validation</code></li>
<li>Performance tests <i>(Coming soon)</i></li>
</ul>
Expand Down

0 comments on commit a042622

Please sign in to comment.