Update .wordpress-org README.md to reflect new asset organization
ci/woodpecker/push/woodpecker Pipeline is pending
Plugin Asset Update / Push assets to WordPress.org (push) Has been cancelled
Build Release / Build and Create Release (push) Has been cancelled
Build Release / Deploy to WordPress.org (push) Has been cancelled
ci/woodpecker/tag/woodpecker Pipeline was successful

This commit is contained in:
marcus committed 2025-04-13 14:57:31 +01:00
1 parent 009b67c0cc
commit 0ced75f9b7
5 files changed
+37 -62

No files matched your search

+37 -8
View File
@@ -5,21 +5,42 @@ This directory contains assets specific to the WordPress.org plugin repository a
## Directory Structure
```
/assets/
icon-256x256.png
icon-128x128.png
banner-772x250.png
banner-1544x500.png
screenshot-1.png
/.wordpress-org/
/assets/
icon-256x256.png
icon-128x128.png
banner-772x250.png
banner-1544x500.png
screenshot-1.png
```
## Asset Organization
- **PNG Files**: All PNG files for WordPress.org are stored in this directory (`.wordpress-org/assets/`)
- **Source Files**: Source files (PXD, SVG) are stored in the main `assets/` directory:
- `assets/banner/banner-1544x500.pxd`
- `assets/icon/icon.svg`
- `assets/icon/icon-1024x1024.pxd`
- `assets/screenshots/screenshot-1.pxd`
## Purpose
When using GitHub Actions for WordPress.org plugin deployments (via the 10up WordPress GitHub Actions), this directory is used to automatically update plugin assets in the WordPress.org repository.
## Naming Conventions
Files must be named exactly as shown above to be properly recognized by the WordPress.org system during the deployment process.
Files must be named exactly as shown above to be properly recognized by the WordPress.org system during the deployment process:
### Banner Images
- `banner-772x250.png` - 772x250 pixel PNG banner (required for WordPress.org)
- `banner-1544x500.png` - 1544x500 pixel PNG banner for high-DPI displays (optional for WordPress.org)
### Icon Images
- `icon-256x256.png` - 256x256 pixel PNG icon (required for WordPress.org)
- `icon-128x128.png` - 128x128 pixel PNG icon (optional for WordPress.org)
### Screenshots
- `screenshot-1.png` - Main screenshot showing the plugin in action
## Right-to-Left (RTL) Support
@@ -31,9 +52,17 @@ For plugins that support Right-to-Left languages (like Hebrew and Arabic), you c
Note that the `-rtl` suffix is specifically for Right-to-Left language support, not for dark mode versions of assets.
## Build Process
The build script (`build.sh`) is configured to:
1. Keep source files (PXD, SVG) in the `assets/` directory for development
2. Use PNG files from the `.wordpress-org/assets/` directory for the build
3. Copy these PNG files to the appropriate locations in the build directory
## Additional Resources
For more detailed information about WordPress.org plugin assets, please see:
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
- [WordPress.org Plugin Submission Assets Guide](../assets/WORDPRESS_ORG_ASSETS.md)
+11
View File
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Generated by Pixelmator Pro 3.6.17 -->
<svg width="1024" height="1024" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<clipPath id="clipPath1">
<path clip-rule="evenodd" d="M 0 940 C 0 986.391918 37.608082 1024 84 1024 L 940 1024 C 986.391907 1024 1024 986.391918 1024 940 L 1024 84 C 1024 37.608093 986.391907 -0 940 -0 L 84 -0 C 37.608082 -0 0 37.608093 0 84 Z"/>
</clipPath>
<image id="Image-Layer" x="0" y="0" width="1024" height="1024" clip-path="url(#clipPath1)" xlink:href="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAABAAAAAQACAYAAAB/HSuDAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAEAKADAAQAAAABAAAEAAAAAADT3eodAABAAElEQVR4AezdMWpUYRiF4f/OpDM7CBaC2GcD7sRCRLCwcCkWFoJYuRDBDdgbccRgGbGI5eR6J5A+02XyPmkUnMCc53zNPTHJNG4+jh8+Xc3r0zHmkzGP47Ga1svfp5t/9icBAgQIECBAgAABAgQIECBw1wWmeVzN2zGNyzGm31fT9uu4PP+ye9fXD/hv332c33/4NL5939z1JN4fAQIECBAgQIAAAQIECBAgcEuBJ48fjVcvn403r18sX+VfvvK/2Zw/P/Pwf0s+LyNAgAABAgQIECBAgAABAochcPHn7/jx89e4+Lf9fLT7b/8e/g+jOO+SAAECBAgQIECAAAECBAjsK7B75l+N9enq+nv+9/1srydAgAABAgQIECBAgAABAgQOSGA+WS0/8O/BAb1jb5UAAQIECBAgQIAAAQIECBDYV2B59l8tP+3/aN/P83oCBAgQIECAAAECBAgQIEDggASWZ//dtwD4VX8H1Jm3SoAAAQIECBAgQIAAAQIE9heYp2UA8EGAAAECBAgQIECAAAECBAjcdwEDwH1vWD4CBAgQIECAAAECBAgQILAIGACcAQECBAgQIECAAAECBAgQCAgYAAIli0iAAAECBAgQIECAAAECBAwAboAAAQIECBAgQIAAAQIECAQEDACBkkUkQIAAAQIECBAgQIAAAQIGADdAgAABAgQIECBAgAABAgQCAgaAQMkiEiBAgAABAgQIECBAgAABA4AbIECAAAECBAgQIECAAAECAQEDQKBkEQkQIECAAAECBAgQIECAgAHADRAgQIAAAQIECBAgQIAAgYCAASBQsogECBAgQIAAAQIECBAgQMAA4AYIECBAgAABAgQIECBAgEBAwAAQKFlEAgQIECBAgAABAgQIECBgAHADBAgQIECAAAECBAgQIEAgIGAACJQsIgECBAgQIECAAAECBAgQMAC4AQIECBAgQIAAAQIECBAgEBAwAARKFpEAAQIECBAgQIAAAQIECBgA3AABAgQIECBAgAABAgQIEAgIGAACJYtIgAABAgQIECBAgAABAgQMAG6AAAECBAgQIECAAAECBAgEBAwAgZJFJECAAAECBAgQIECAAAECBgA3QIAAAQIECBAgQIAAAQIEAgIGgEDJIhIgQIAAAQIECBAgQIAAAQOAGyBAgAABAgQIECBAgAABAgEBA0CgZBEJECBAgAABAgQIECBAgIABwA0QIECAAAECBAgQIECAAIGAgAEgULKIBAgQIECAAAECBAgQIEDAAOAGCBAgQIAAAQIECBAgQIBAQMAAEChZRAIECBAgQIAAAQIECBAgYABwAwQIECBAgAABAgQIECBAICBgAAiULCIBAgQIECBAgAABAgQIEDAAuAECBAgQIECAAAECBAgQIBAQMAAEShaRAAECBAgQIECAAAECBAgYANwAAQIECBAgQIAAAQIECBAICBgAAiWLSIAAAQIECBAgQIAAAQIEDABugAABAgQIECBAgAABAgQIBAQMAIGSRSRAgAABAgQIECBAgAABAgYAN0CAAAECBAgQIECAAAECBAICBoBAySISIECAAAECBAgQIECAAAEDgBsgQIAAAQIECBAgQIAAAQIBAQNAoGQRCRAgQIAAAQIECBAgQICAAcANECBAgAABAgQIECBAgACBgIABIFCyiAQIECBAgAABAgQIECBAwADgBggQIECAAAECBAgQIECAQEDAABAoWUQCBAgQIECAAAECBAgQIGAAcAMECBAgQIAAAQIECBAgQCAgYAAIlCwiAQIECBAgQIAAAQIECBAwALgBAgQIECBAgAABAgQIECAQEDAABEoWkQABAgQIECBAgAABAgQIGADcAAECBAgQIECAAAECBAgQCAgYAAIli0iAAAECBAgQIECAAAECBAwAboAAAQIECBAgQIAAAQIECAQEDACBkkUkQIAAAQIECBAgQIAAAQIGADdAgAABAgQIECBAgAABAgQCAgaAQMkiEiBAgAABAgQIECBAgAABA4AbIECAAAECBAgQIECAAAECAQEDQKBkEQkQIECAAAECBAgQIECAgAHADRAgQIAAAQIECBAgQIAAgYCAASBQsogECBAgQIAAAQIECBAgQMAA4AYIECBAgAABAgQIECBAgEBAwAAQKFlEAgQIECBAgAABAgQIECBgAHADBAgQIECAAAECBAgQIEAgIGAACJQsIgECBAgQIECAAAECBAgQMAC4AQIECBAgQIAAAQIECBAgEBAwAARKFpEAAQIECBAgQIAAAQIECBgA3AABAgQIECBAgAABAgQIEAgIGAACJYtIgAABAgQIECBAgAABAgQMAG6AAAECBAgQIECAAAECBAgEBAwAgZJFJECAAAECBAgQIECAAAECBgA3QIAAAQIECBAgQIAAAQIEAgIGgEDJIhIgQIAAAQIECBAgQIAAAQOAGyBAgAABAgQIECBAgAABAgEBA0CgZBEJECBAgAABAgQIECBAgIABwA0QIECAAAECBAgQIECAAIGAgAEgULKIBAgQIECAAAECBAgQIEDAAOAGCBAgQIAAAQIECBAgQIBAQMAAEChZRAIECBAgQIAAAQIECBAgYABwAwQIECBAgAABAgQIECBAICBgAAiULCIBAgQIECBAgAABAgQIEDAAuAECBAgQIECAAAECBAgQIBAQMAAEShaRAAECBAgQIECAAAECBAgYANwAAQIECBAgQIAAAQIECBAICBgAAiWLSIAAAQIECBAgQIAAAQIEDABugAABAgQIECBAgAABAgQIBAQMAIGSRSRAgAABAgQIECBAgAABAgYAN0CAAAECBAgQIECAAAECBAICBoBAySISIECAAAECBAgQIECAAAEDgBsgQIAAAQIECBAgQIAAAQIBAQNAoGQRCRAgQIAAAQIECBAgQICAAcANECBAgAABAgQIECBAgACBgIABIFCyiAQIECBAgAABAgQIECBAwADgBggQIECAAAECBAgQIECAQEDAABAoWUQCBAgQIECAAAECBAgQIGAAcAMECBAgQIAAAQIECBAgQCAgYAAIlCwiAQIECBAgQIAAAQIECBAwALgBAgQIECBAgAABAgQIECAQEDAABEoWkQABAgQIECBAgAABAgQIGADcAAECBAgQIECAAAECBAgQCAgYAAIli0iAAAECBAgQIECAAAECBAwAboAAAQIECBAgQIAAAQIECAQEDACBkkUkQIAAAQIECBAgQIAAAQIGADdAgAABAgQIECBAgAABAgQCAgaAQMkiEiBAgAABAgQIECBAgAABA4AbIECAAAECBAgQIECAAAECAQEDQKBkEQkQIECAAAECBAgQIECAgAHADRAgQIAAAQIECBAgQIAAgYCAASBQsogECBAgQIAAAQIECBAgQMAA4AYIECBAgAABAgQIECBAgEBAwAAQKFlEAgQIECBAgAABAgQIECBgAHADBAgQIECAAAECBAgQIEAgIGAACJQsIgECBAgQIECAAAECBAgQMAC4AQIECBAgQIAAAQIECBAgEBAwAARKFpEAAQIECBAgQIAAAQIECBgA3AABAgQIECBAgAABAgQIEAgIGAACJYtIgAABAgQIECBAgAABAgQMAG6AAAECBAgQIECAAAECBAgEBAwAgZJFJECAAAECBAgQIECAAAECBgA3QIAAAQIECBAgQIAAAQIEAgIGgEDJIhIgQIAAAQIECBAgQIAAAQOAGyBAgAABAgQIECBAgAABAgEBA0CgZBEJECBAgAABAgQIECBAgIABwA0QIECAAAECBAgQIECAAIGAgAEgULKIBAgQIECAAAECBAgQIEDAAOAGCBAgQIAAAQIECBAgQIBAQMAAEChZRAIECBAgQIAAAQIECBAgYABwAwQIECBAgAABAgQIECBAICBgAAiULCIBAgQIECBAgAABAgQIEDAAuAECBAgQIECAAAECBAgQIBAQMAAEShaRAAECBAgQIECAAAECBAgYANwAAQIECBAgQIAAAQIECBAICBgAAiWLSIAAAQIECBAgQIAAAQIEDABugAABAgQIECBAgAABAgQIBAQMAIGSRSRAgAABAgQIECBAgAABAgYAN0CAAAECBAgQIECAAAECBAICBoBAySISIECAAAECBAgQIECAAAEDgBsgQIAAAQIECBAgQIAAAQIBAQNAoGQRCRAgQIAAAQIECBAgQICAAcANECBAgAABAgQIECBAgACBgIABIFCyiAQIECBAgAABAgQIECBAwADgBggQIECAAAECBAgQIECAQEDAABAoWUQCBAgQIECAAAECBAgQIGAAcAMECBAgQIAAAQIECBAgQCAgYAAIlCwiAQIECBAgQIAAAQIECBAwALgBAgQIECBAgAABAgQIECAQEDAABEoWkQABAgQIECBAgAABAgQIGADcAAECBAgQIECAAAECBAgQCAgYAAIli0iAAAECBAgQIECAAAECBAwAboAAAQIECBAgQIAAAQIECAQEDACBkkUkQIAAAQIECBAgQIAAAQIGADdAgAABAgQIECBAgAABAgQCAgaAQMkiEiBAgAABAgQIECBAgAABA4AbIECAAAECBAgQIECAAAECAQEDQKBkEQkQIECAAAECBAgQIECAgAHADRAgQIAAAQIECBAgQIAAgYCAASBQsogECBAgQIAAAQIECBAgQMAA4AYIECBAgAABAgQIECBAgEBAwAAQKLine truncated
<path id="directorymissing-1630" fill="#ff999b" fill-rule="evenodd" stroke="none" d="M 854.400024 683.200012 L 940 683.200012 L 940 597.599976 L 854.400024 597.599976 L 854.400024 683.200012 Z M 683.200012 340.799988 L 768.799988 340.799988 L 768.799988 255.200012 L 683.200012 255.200012 L 683.200012 340.799988 Z M 854.400024 512 L 940 512 L 940 426.400024 L 854.400024 426.400024 L 854.400024 512 Z M 255.199997 84 L 84 84 L 84 255.200012 L 169.600006 255.200012 L 169.600006 169.599976 L 255.199997 169.599976 L 255.199997 84 Z M 854.400024 854.400024 L 768.799988 854.400024 L 768.799988 940 L 940 940 L 940 768.799988 L 854.400024 768.799988 L 854.400024 854.400024 Z M 84 940 L 169.600006 940 L 169.600006 854.400024 L 84 854.400024 L 84 940 Z M 597.599976 940 L 683.200012 940 L 683.200012 854.400024 L 597.599976 854.400024 L 597.599976 940 Z M 84 426.400024 L 169.600006 426.400024 L 169.600006 340.799988 L 84 340.799988 L 84 426.400024 Z M 84 597.599976 L 169.600006 597.599976 L 169.600006 512 L 84 512 L 84 597.599976 Z M 854.400024 340.799988 L 940 340.799988 L 940 255.200012 L 854.400024 255.200012 L 854.400024 340.799988 Z M 84 768.799988 L 169.600006 768.799988 L 169.600006 683.200012 L 84 683.200012 L 84 768.799988 Z M 512 340.799988 L 597.599976 340.799988 L 597.599976 255.200012 L 512 255.200012 L 512 340.799988 Z M 340.799988 169.599976 L 426.399994 169.599976 L 426.399994 84 L 340.799988 84 L 340.799988 169.599976 Z M 255.199997 940 L 340.799988 940 L 340.799988 854.400024 L 255.199997 854.400024 L 255.199997 940 Z M 426.399994 940 L 512 940 L 512 854.400024 L 426.399994 854.400024 L 426.399994 940 Z"/>
<text id="Fixed" xml:space="preserve" x="241.56" y="597" font-family="Zilla Slab" font-size="240" font-weight="500" fill="#ff999b" letter-spacing="-7.2">Fixed</text>
<path id="Plug" fill="#ff999b" stroke="none" d="M 265.881927 222.038574 C 259.955475 222.038635 255.151138 226.842957 255.151138 232.769409 L 255.151138 254.230896 L 222.958862 254.230896 C 217.032394 254.230896 212.228058 259.035217 212.228119 264.96167 L 212.228104 329.34613 C 212.228104 335.272583 217.03244 340.076965 222.958862 340.076904 L 255.151138 340.076965 L 255.151138 361.538391 C 255.151138 367.464844 259.955475 372.269226 265.881897 372.269165 L 340.997223 372.269226 L 340.997162 383 L 362.45874 383 L 362.45874 340.076965 L 426.843292 340.076965 L 426.843292 318.615479 L 362.45874 318.615417 L 362.45874 275.692383 L 426.843262 275.692383 L 426.843292 254.230896 L 362.45871 254.230896 L 362.45871 211.307861 L 340.997223 211.3078 L 340.997192 222.038574 Z"/>
</svg>

After

Width:  |  Height:  |  Size: 30 KiB