Deduplicate asset storage and update documentation
Some checks failed
ci/woodpecker/push/woodpecker Pipeline is pending
ci/woodpecker/tag/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

This commit is contained in:
2025-04-13 14:49:29 +01:00
parent eac794c54a
commit 009b67c0cc
13 changed files with 77 additions and 22 deletions

View File

@ -177,10 +177,14 @@ Before releasing:
### Local Testing Environment
- Local WordPress testing environment is at ~/Local/plugin-testing/app/public
- Plugin testing directory is at ~/Local/plugin-testing/app/public/wp-content/plugins
- WP-CLI is available at ~/Local/plugin-testing/app/bin/wp
- Debug logs can be found at ~/Local/plugin-testing/app/public/wp-content/uploads/debug-log-manager/ if the Debug Log Manager plugin is installed
Local environment variables and paths are documented in `.ai-workflows/local-env-vars.md`. This includes:
- Repository paths
- Local WordPress testing environment paths
- URLs for testing and development tools
- Build and deploy script locations
Refer to this file for the most up-to-date information about the local development environment.
### Using WP-CLI with LocalWP

View File

@ -171,7 +171,7 @@ Contributions are welcome! Please follow these steps to set up a development env
1. Install [LocalWP](https://localwp.com/) and create a clean site called "Plugin Testing" using the "Preferred" setup option
2. Run "Site shell" once from the LocalWP page on the site's settings to ensure wp-cli is enabled
3. Run "Add Run Configurations to VS Code" to update site configuration files in: ~/Local/plugin-testing/conf/
4. Clone this repository to your local machine
4. Clone this repository to your local machine, in `~/Git/` or wherever you keep your Git repositories.
5. Use the build.sh and deploy-local.sh scripts to build and deploy the plugin for testing
[AugmentCode.com](https://augmentcode.com/) is recommended as a good all-in-one AI IDE for plugin development and testing.

View File

@ -39,7 +39,7 @@ Note: `-rtl` is specifically for Right-to-Left language support, not for dark th
- Required: 256x256 pixels (`icon-256x256.png`)
- Optional: 128x128 pixels (`icon-128x128.png`)
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ✅ READY - Files are in `assets/icon/`
- **Status**: ✅ READY - Files are in `.wordpress-org/assets/`
### Banner
@ -48,15 +48,14 @@ Note: `-rtl` is specifically for Right-to-Left language support, not for dark th
- Required: 772x250 pixels (`banner-772x250.png`)
- Optional: 1544x500 pixels (`banner-1544x500.png`) for high-DPI displays
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ✅ READY - Files are in `assets/banner/`
- **Status**: ✅ READY - Files are in `.wordpress-org/assets/`
### Screenshots
- **Format**: PNG
- **Naming**: `screenshot-1.png`
- **Location**: Upload to the `/assets/` directory in the WordPress.org SVN repository
- **Status**: ✅ READY
- `screenshot-1.png` is available in `assets/screenshots/`
- **Status**: ✅ READY - Files are in `.wordpress-org/assets/`
## Submission Process
@ -78,11 +77,11 @@ Note: `-rtl` is specifically for Right-to-Left language support, not for dark th
cp -r [your-local-plugin-files]/* fix-plugin-does-not-exist-notices/trunk/
# Copy assets to assets directory
cp assets/icon/icon-256x256.png fix-plugin-does-not-exist-notices/assets/
cp assets/icon/icon-128x128.png fix-plugin-does-not-exist-notices/assets/
cp assets/banner/banner-772x250.png fix-plugin-does-not-exist-notices/assets/
cp assets/banner/banner-1544x500.png fix-plugin-does-not-exist-notices/assets/
cp assets/screenshots/screenshot-1.png fix-plugin-does-not-exist-notices/assets/
cp .wordpress-org/assets/icon-256x256.png fix-plugin-does-not-exist-notices/assets/
cp .wordpress-org/assets/icon-128x128.png fix-plugin-does-not-exist-notices/assets/
cp .wordpress-org/assets/banner-772x250.png fix-plugin-does-not-exist-notices/assets/
cp .wordpress-org/assets/banner-1544x500.png fix-plugin-does-not-exist-notices/assets/
cp .wordpress-org/assets/screenshot-1.png fix-plugin-does-not-exist-notices/assets/
# Add new files
cd fix-plugin-does-not-exist-notices

View File

@ -1,12 +1,15 @@
# WordPress.org Banner Files
This directory contains banner files for the WordPress.org plugin repository.
This directory contains source files for banners. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
## Files in this Directory
- `banner-1544x500.pxd` - Source file for editing in Pixelmator
## Files in .wordpress-org/assets/
- `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)
- `banner-1544x500.pxd` - Source file for editing in Pixelmator
## WordPress.org Submission

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

View File

@ -1,13 +1,16 @@
# WordPress.org Icon Files
This directory contains icon files for the WordPress.org plugin repository.
This directory contains source files for icons. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
## Files in this Directory
- `icon.svg` - Source SVG icon
- `icon-1024x1024.pxd` - Source file for editing in Pixelmator
## Files in .wordpress-org/assets/
- `icon-256x256.png` - 256x256 pixel PNG icon (required for WordPress.org)
- `icon-128x128.png` - 128x128 pixel PNG icon (optional for WordPress.org)
- `icon-1024x1024.pxd` - Source file for editing in Pixelmator
## WordPress.org Submission

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

View File

@ -1,12 +1,15 @@
# WordPress.org Screenshot Files
This directory contains screenshot files for the WordPress.org plugin repository.
This directory contains source files for screenshots. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
## Files in this Directory
- `screenshot-1.png` - Main screenshot showing the plugin in action
- `screenshot-1.pxd` - Source file for editing in Pixelmator
## Files in .wordpress-org/assets/
- `screenshot-1.png` - Main screenshot showing the plugin in action
## WordPress.org Submission
For detailed information about WordPress.org screenshot requirements and submission process, please see the main asset documentation:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 392 KiB

View File

@ -37,8 +37,37 @@ mkdir -p $BUILD_DIR/includes
cp -r includes/* $BUILD_DIR/includes/
mkdir -p $BUILD_DIR/languages
cp -r languages/* $BUILD_DIR/languages/
mkdir -p $BUILD_DIR/assets
cp -r assets/* $BUILD_DIR/assets/
# Copy assets
mkdir -p $BUILD_DIR/assets/css
cp -r assets/css/* $BUILD_DIR/assets/css/
mkdir -p $BUILD_DIR/assets/js
cp -r assets/js/* $BUILD_DIR/assets/js/
# Copy asset source files (PXD)
mkdir -p $BUILD_DIR/assets/banner
cp -r assets/banner/*.pxd $BUILD_DIR/assets/banner/ 2>/dev/null || :
mkdir -p $BUILD_DIR/assets/icon
cp -r assets/icon/*.pxd $BUILD_DIR/assets/icon/ 2>/dev/null || :
mkdir -p $BUILD_DIR/assets/screenshots
cp -r assets/screenshots/*.pxd $BUILD_DIR/assets/screenshots/ 2>/dev/null || :
# Copy README files from assets directories
cp -r assets/README.md $BUILD_DIR/assets/ 2>/dev/null || :
cp -r assets/banner/README.md $BUILD_DIR/assets/banner/ 2>/dev/null || :
cp -r assets/icon/README.md $BUILD_DIR/assets/icon/ 2>/dev/null || :
cp -r assets/screenshots/README.md $BUILD_DIR/assets/screenshots/ 2>/dev/null || :
cp -r assets/WORDPRESS_ORG_ASSETS.md $BUILD_DIR/assets/ 2>/dev/null || :
cp -r assets/WORDPRESS_ORG_SUBMISSION.md $BUILD_DIR/assets/ 2>/dev/null || :
# Copy PNG files from .wordpress-org/assets to the build directory
mkdir -p $BUILD_DIR/assets/banner
cp -r .wordpress-org/assets/banner-*.png $BUILD_DIR/assets/banner/ 2>/dev/null || :
mkdir -p $BUILD_DIR/assets/icon
cp -r .wordpress-org/assets/icon-*.png $BUILD_DIR/assets/icon/ 2>/dev/null || :
mkdir -p $BUILD_DIR/assets/screenshots
cp -r .wordpress-org/assets/screenshot-*.png $BUILD_DIR/assets/screenshots/ 2>/dev/null || :
mkdir -p $BUILD_DIR/vendor
cp -r vendor/* $BUILD_DIR/vendor/

View File

@ -109,6 +109,20 @@ If no preference is set, the plugin will automatically use the source it was ins
**Note:** GitHub and Gitea options require the Git Updater plugin to be installed and activated.
== Contributing ==
Contributions are welcome! Please follow these steps to set up a development environment:
1. Install [LocalWP](https://localwp.com/) and create a clean site called "Plugin Testing" using the "Preferred" setup option
2. Run "Site shell" once from the LocalWP page on the site's settings to ensure wp-cli is enabled
3. Run "Add Run Configurations to VS Code" to update site configuration files in: ~/Local/plugin-testing/conf/
4. Clone this repository to your local machine
5. Use the build.sh and deploy-local.sh scripts to build and deploy the plugin for testing
[AugmentCode.com](https://augmentcode.com/) is recommended as a good all-in-one AI IDE for plugin development and testing.
Please feel free to submit a Pull Request with your improvements.
== Frequently Asked Questions ==
= Is it safe to remove plugin references? =