Compare commits
8 Commits
v2.2.0-1
...
ef3108113e
| Author | SHA1 | Date | |
|---|---|---|---|
| ef3108113e | |||
| 65f784a461 | |||
| e4c70b5711 | |||
| c73964888b | |||
| c5d3c7672c | |||
| e1da072640 | |||
| b988fbbec0 | |||
| ac3e47a147 |
256
.ai-assistant.md
256
.ai-assistant.md
@ -2,25 +2,6 @@
|
||||
|
||||
This guide helps AI assistants understand the project structure, workflows, and best practices for this repository.
|
||||
|
||||
## AI IDE Configuration
|
||||
|
||||
This repository includes configuration files for various AI-powered development tools:
|
||||
|
||||
- `.aiconfig` - General AI configuration (model preferences, ignore patterns)
|
||||
- `.augmentignore` - Ignore patterns for Augment
|
||||
- `.cursorignore` - Ignore patterns for Cursor
|
||||
- `.v0ignore` - Ignore patterns for v0
|
||||
- `.windsurfignore` - Ignore patterns for Windsurf
|
||||
- `.clinerc` - Configuration for Cline
|
||||
- `.rooignore` - Ignore patterns for Roo
|
||||
- `.geminiignore` - Ignore patterns for Gemini Code Assist
|
||||
- `.loveablerc` - Configuration for Loveable
|
||||
- `.boltignore` - Ignore patterns for Bolt
|
||||
- `.codyignore` - Ignore patterns for Cody
|
||||
- `.continuerc` - Configuration for Continue
|
||||
|
||||
All these files respect `.gitignore` patterns and only include additional tool-specific patterns. The `!` prefix can be used in these files to include files that are excluded by `.gitignore`.
|
||||
|
||||
## Project Overview
|
||||
|
||||
- **Plugin Name**: Fix 'Plugin file does not exist' Notices
|
||||
@ -29,127 +10,41 @@ All these files respect `.gitignore` patterns and only include additional tool-s
|
||||
|
||||
This plugin helps users clean up references to deleted plugins that cause "Plugin file does not exist" errors in the WordPress admin. It adds missing plugins to the plugins list with a "Remove Notice" link to safely remove invalid plugin entries.
|
||||
|
||||
## Reference Plugins
|
||||
## AI Workflows
|
||||
|
||||
The `reference-plugins/` directory contains plugins that can be used for reference or inspiration. When developing new features or improving existing ones, you should:
|
||||
Detailed workflow documentation is available in the `.ai-workflows/` directory:
|
||||
|
||||
1. Examine these reference plugins for best practices in code structure, organization, and implementation
|
||||
2. Look for patterns in how they handle similar functionality
|
||||
3. Consider their approach to user interface design and user experience
|
||||
4. Study their documentation style and thoroughness
|
||||
|
||||
These plugins are not part of the codebase and are ignored by Git, but they provide valuable examples of WordPress plugin development standards and techniques.
|
||||
- **@.ai-workflows/bug-fixing.md**: Guidelines for identifying and fixing bugs
|
||||
- **@.ai-workflows/code-review.md**: Standards for reviewing code changes
|
||||
- **@.ai-workflows/feature-development.md**: Process for developing new features
|
||||
- **@.ai-workflows/local-env-vars.md**: Local development environment paths and URLs
|
||||
- **@.ai-workflows/release-process.md**: Steps for preparing and publishing releases
|
||||
|
||||
## Version Management
|
||||
|
||||
### Version Numbering Convention
|
||||
|
||||
We follow [Semantic Versioning](https://semver.org/):
|
||||
- **MAJOR.MINOR.PATCH** (e.g., 1.6.0)
|
||||
- **MAJOR.MINOR.PATCH** (e.g., 2.2.2)
|
||||
- **MAJOR**: Breaking changes
|
||||
- **MINOR**: New features, non-breaking
|
||||
- **PATCH**: Bug fixes, non-breaking
|
||||
|
||||
### When to Increment Version Numbers
|
||||
When updating version numbers, see **@.ai-workflows/release-process.md** for the complete checklist.
|
||||
|
||||
- **PATCH** (1.6.0 → 1.6.1):
|
||||
- Bug fixes
|
||||
- Small text changes
|
||||
- Minor improvements that don't add new features
|
||||
|
||||
- **MINOR** (1.6.0 → 1.7.0):
|
||||
- New features
|
||||
- Significant improvements to existing functionality
|
||||
- Deprecation of features (but not removal)
|
||||
|
||||
- **MAJOR** (1.6.0 → 2.0.0):
|
||||
- Breaking changes
|
||||
- Removal of features
|
||||
- Major architectural changes
|
||||
|
||||
### Version Update Checklist
|
||||
|
||||
When updating the version number, always update these files:
|
||||
1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
2. `CHANGELOG.md` (Add new version section)
|
||||
3. `readme.txt` (Stable tag and Changelog section)
|
||||
4. `README.md` (Update Changelog section to match readme.txt)
|
||||
5. Update `FPDEN_VERSION` constant in the main plugin file
|
||||
6. Update `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version and POT-Creation-Date)
|
||||
|
||||
**IMPORTANT**: Always ensure README.md is kept in sync with readme.txt for consistency across platforms.
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion. All three files must be updated with the same changes for each release.
|
||||
|
||||
## Git Workflow
|
||||
|
||||
### Branch Naming Convention
|
||||
|
||||
- Feature branches: `feature/descriptive-name`
|
||||
- Bug fix branches: `fix/issue-description`
|
||||
- Release branches: `v{MAJOR}.{MINOR}.{PATCH}`
|
||||
|
||||
### Commit Message Guidelines
|
||||
|
||||
- Use present tense ("Add feature" not "Added feature")
|
||||
- Start with a verb
|
||||
- Keep the first line under 50 characters
|
||||
- Reference issues when relevant: "Fix #123: Resolve plugin detection issue"
|
||||
|
||||
### Pre-Release Checklist
|
||||
|
||||
Before creating a new release, verify the following:
|
||||
|
||||
- [ ] Determine the correct version increment (MAJOR, MINOR, or PATCH) based on the changes
|
||||
- [ ] Ensure all changes are documented in CHANGELOG.md
|
||||
- [ ] Verify all code changes are tested and working correctly
|
||||
- [ ] Check that all files are properly formatted and follow WordPress coding standards
|
||||
- [ ] Ensure Git Updater configuration is correct (if applicable)
|
||||
|
||||
### Release Process
|
||||
|
||||
1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}`
|
||||
2. Update version numbers in ALL required files:
|
||||
- `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
|
||||
- `FPDEN_VERSION` constant in the main plugin file
|
||||
- `readme.txt` (Stable tag)
|
||||
- `README.md` (Ensure changelog is updated)
|
||||
- `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version)
|
||||
- Any other files that reference the version number
|
||||
3. Update CHANGELOG.md with all changes
|
||||
4. Update readme.txt changelog section
|
||||
5. Update README.md changelog section to match readme.txt
|
||||
6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
|
||||
7. Test changes locally on the version branch
|
||||
8. When satisfied with testing, merge to main:
|
||||
```
|
||||
git checkout main
|
||||
git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
|
||||
```
|
||||
9. Push main to all remotes:
|
||||
```
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
10. Create and push a tag to trigger the GitHub Actions workflow:
|
||||
```
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
11. Verify the GitHub Actions workflow completes successfully
|
||||
|
||||
## Build Process
|
||||
|
||||
The build process is handled by `build.sh`:
|
||||
1. Updates version numbers
|
||||
2. Installs composer dependencies
|
||||
3. Copies files to build directory
|
||||
4. Creates ZIP file
|
||||
|
||||
To manually build the plugin:
|
||||
```
|
||||
./build.sh {MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
## Remote Repositories
|
||||
|
||||
The plugin is hosted on multiple repositories:
|
||||
@ -159,13 +54,15 @@ The plugin is hosted on multiple repositories:
|
||||
|
||||
Always push changes to all remotes to keep them in sync.
|
||||
|
||||
## GitHub Actions
|
||||
## Git Updater Integration
|
||||
|
||||
The repository uses GitHub Actions for automated builds and deployments:
|
||||
- Triggered by tags matching the pattern `v*`
|
||||
- Builds the plugin
|
||||
- Creates a GitHub release
|
||||
- Deploys to WordPress.org
|
||||
The plugin integrates with Git Updater to allow updates directly from GitHub or Gitea. Important notes:
|
||||
|
||||
1. Git Updater reads version information from the readme.txt file in the main branch, not from tags or releases
|
||||
2. Always merge release changes to the main branch immediately after creating a tag
|
||||
3. The plugin includes proper headers for Git Updater in the main plugin file
|
||||
|
||||
See **@.ai-workflows/release-process.md** for detailed Git Updater integration steps.
|
||||
|
||||
## Testing Guidelines
|
||||
|
||||
@ -175,119 +72,8 @@ Before releasing:
|
||||
3. Verify all features work as expected
|
||||
4. Check for any PHP warnings or notices
|
||||
|
||||
### Local Testing Environment
|
||||
Local environment variables and paths are documented in **@.ai-workflows/local-env-vars.md**.
|
||||
|
||||
Local environment variables and paths are documented in `.ai-workflows/local-env-vars.md`. This includes:
|
||||
## Common Tasks
|
||||
|
||||
- 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
|
||||
|
||||
WP-CLI can be used with LocalWP for various tasks:
|
||||
|
||||
```bash
|
||||
# Navigate to the WordPress directory
|
||||
cd ~/Local/plugin-testing/app/public
|
||||
|
||||
# Run WP-CLI commands
|
||||
~/Local/plugin-testing/app/bin/wp plugin list
|
||||
~/Local/plugin-testing/app/bin/wp transient delete --all
|
||||
~/Local/plugin-testing/app/bin/wp cache flush
|
||||
```
|
||||
|
||||
## Common Tasks for AI Assistants
|
||||
|
||||
### Creating a New Release
|
||||
|
||||
```
|
||||
# 1. Create a new branch
|
||||
git checkout main
|
||||
git checkout -b v1.7.0
|
||||
|
||||
# 2. Update version numbers in ALL required files
|
||||
# - wp-fix-plugin-does-not-exist-notices.php
|
||||
# - CHANGELOG.md
|
||||
# - readme.txt
|
||||
# - README.md
|
||||
# - languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
# - FPDEN_VERSION constant
|
||||
|
||||
# 3. Commit changes
|
||||
git add .
|
||||
git commit -m "Prepare release v1.7.0"
|
||||
|
||||
# 4. Test changes locally on the version branch
|
||||
# (Run tests, verify functionality)
|
||||
|
||||
# 5. Merge to main when ready
|
||||
git checkout main
|
||||
git merge v1.7.0 --no-ff
|
||||
|
||||
# 6. Push main to remotes
|
||||
git push github main
|
||||
git push gitea main
|
||||
|
||||
# 7. Create and push tag
|
||||
git tag -a v1.7.0 -m "Release version 1.7.0"
|
||||
git push github refs/tags/v1.7.0
|
||||
git push gitea refs/tags/v1.7.0
|
||||
```
|
||||
|
||||
### Adding a New Feature
|
||||
|
||||
```
|
||||
# 1. Create feature branch from main
|
||||
git checkout main
|
||||
git checkout -b feature/new-feature-name
|
||||
|
||||
# 2. Make changes and commit
|
||||
git add .
|
||||
git commit -m "Add new feature"
|
||||
|
||||
# 3. Test locally
|
||||
# (Run tests, verify functionality)
|
||||
|
||||
# 4. When ready for release, merge to a version branch
|
||||
git checkout -b v1.7.0
|
||||
git merge feature/new-feature-name --no-ff
|
||||
|
||||
# 5. Continue with the release process
|
||||
# (Update version numbers, etc.)
|
||||
```
|
||||
|
||||
### Fixing a Bug
|
||||
|
||||
```
|
||||
# 1. Create bugfix branch from main
|
||||
git checkout main
|
||||
git checkout -b fix/bug-description
|
||||
|
||||
# 2. Make changes and commit
|
||||
git add .
|
||||
git commit -m "Fix #123: Fix bug description"
|
||||
|
||||
# 3. Test locally
|
||||
# (Run tests, verify functionality)
|
||||
|
||||
# 4. When ready for release, merge to a version branch
|
||||
git checkout -b v1.6.5
|
||||
git merge fix/bug-description --no-ff
|
||||
|
||||
# 5. Continue with the release process
|
||||
# (Update version numbers, etc.)
|
||||
```
|
||||
|
||||
### Testing a Previous Version
|
||||
|
||||
```
|
||||
# Checkout a specific tag for testing
|
||||
git checkout v1.6.3
|
||||
|
||||
# Or create a test branch from a specific tag
|
||||
git checkout v1.6.3 -b test/some-feature
|
||||
```
|
||||
For detailed instructions on common tasks like creating releases, adding features, fixing bugs, and testing previous versions, see **@.ai-workflows/release-process.md**.
|
||||
|
||||
@ -7,6 +7,7 @@ This directory contains workflow documentation for AI assistants working with th
|
||||
- **bug-fixing.md**: Guidelines for identifying and fixing bugs in the codebase
|
||||
- **code-review.md**: Standards and procedures for reviewing code changes
|
||||
- **feature-development.md**: Process for developing new features
|
||||
- **local-env-vars.md**: Local development environment paths and URLs
|
||||
- **release-process.md**: Steps for preparing and publishing new releases
|
||||
|
||||
These documents help ensure consistent quality and approach when using AI tools to assist with development tasks.
|
||||
|
||||
@ -21,15 +21,23 @@ Based on the changes made, determine the appropriate version increment:
|
||||
|
||||
## Release Steps
|
||||
|
||||
### 1. Create a New Branch
|
||||
### 1. Start from a Feature Branch or Create a New Branch
|
||||
|
||||
You can either use an existing feature branch or create a new branch specifically for the release:
|
||||
|
||||
```bash
|
||||
# Option 1: Use existing feature branch
|
||||
git checkout feature/branch-name
|
||||
|
||||
# Option 2: Create a new branch
|
||||
git checkout -b v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
Example:
|
||||
```bash
|
||||
git checkout -b v1.7.0
|
||||
git checkout feature/refactor-and-improvements
|
||||
# or
|
||||
git checkout -b v2.2.1
|
||||
```
|
||||
|
||||
### 2. Update Version Numbers
|
||||
@ -38,42 +46,68 @@ Update the version number in the following files:
|
||||
|
||||
#### a. Main Plugin File (wp-fix-plugin-does-not-exist-notices.php)
|
||||
|
||||
Update both the plugin header and the version parameter in the Plugin class initialization:
|
||||
|
||||
```php
|
||||
/**
|
||||
* Plugin Name: Fix 'Plugin file does not exist.' Notices
|
||||
* Plugin URI: https://wordpress.org/plugins/fix-plugin-does-not-exist-notices/
|
||||
* Description: Adds missing plugins to the plugins list with a "Remove Reference" link so you can permanently clean up invalid plugin entries and remove error notices.
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: {MAJOR}.{MINOR}.{PATCH}
|
||||
* ...
|
||||
*/
|
||||
|
||||
// At the bottom of the file, update the version parameter:
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '{MAJOR}.{MINOR}.{PATCH}');
|
||||
```
|
||||
|
||||
Also update the FPDEN_VERSION constant:
|
||||
#### b. JavaScript Files with Version Constants
|
||||
|
||||
```php
|
||||
define( 'FPDEN_VERSION', '{MAJOR}.{MINOR}.{PATCH}' );
|
||||
Check for any JavaScript files that might contain version constants:
|
||||
|
||||
```javascript
|
||||
// Current plugin version - this should match the version in the main plugin file
|
||||
const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}';
|
||||
```
|
||||
|
||||
#### b. CHANGELOG.md
|
||||
**Note**: As of version 2.2.1, we've removed redundant JavaScript files like `version-fix.js` since Git Updater now correctly detects the version from the main branch.
|
||||
|
||||
#### c. CHANGELOG.md
|
||||
|
||||
Add a new section at the top of the CHANGELOG.md file:
|
||||
|
||||
```markdown
|
||||
## [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
|
||||
### Added
|
||||
- New feature 1
|
||||
- New feature 2
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
### Changed
|
||||
#### [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
|
||||
#### Added/Changed/Fixed
|
||||
- Change 1
|
||||
- Change 2
|
||||
- Change 3
|
||||
|
||||
### Fixed
|
||||
- Bug fix 1
|
||||
- Bug fix 2
|
||||
#### [{PREVIOUS_VERSION}] - YYYY-MM-DD
|
||||
```
|
||||
|
||||
#### c. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
|
||||
Note: Use the `####` heading format for consistency with the existing CHANGELOG.md structure.
|
||||
|
||||
#### d. README.md
|
||||
|
||||
Update the Changelog section in the main README.md file to match the changes in readme.txt:
|
||||
|
||||
```markdown
|
||||
## Changelog
|
||||
|
||||
### {MAJOR}.{MINOR}.{PATCH}
|
||||
* Change 1
|
||||
* Change 2
|
||||
* Change 3
|
||||
|
||||
### {PREVIOUS_VERSION}
|
||||
```
|
||||
|
||||
**IMPORTANT**: Always keep the changelogs in README.md, readme.txt, and CHANGELOG.md in sync to avoid confusion.
|
||||
|
||||
#### e. POT File (languages/wp-fix-plugin-does-not-exist-notices.pot)
|
||||
|
||||
Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget this step!):
|
||||
|
||||
@ -84,7 +118,7 @@ Update the Project-Id-Version and POT-Creation-Date (IMPORTANT - don't forget th
|
||||
|
||||
Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD.
|
||||
|
||||
#### d. readme.txt
|
||||
#### f. readme.txt
|
||||
|
||||
Update the stable tag:
|
||||
|
||||
@ -96,73 +130,91 @@ Add a new entry to the changelog section:
|
||||
|
||||
```
|
||||
= {MAJOR}.{MINOR}.{PATCH} =
|
||||
* New feature 1
|
||||
* New feature 2
|
||||
* Change 1
|
||||
* Change 2
|
||||
* Fixed bug 1
|
||||
* Fixed bug 2
|
||||
* Change 3
|
||||
```
|
||||
|
||||
Update the upgrade notice section:
|
||||
### 3. Build and Test Locally
|
||||
|
||||
```
|
||||
= {MAJOR}.{MINOR}.{PATCH} =
|
||||
Brief description of the most important changes in this release
|
||||
```
|
||||
|
||||
### 3. Commit Changes
|
||||
Run the build script to create the plugin ZIP file and deploy to your local WordPress testing environment:
|
||||
|
||||
```bash
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md readme.txt README.md languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"
|
||||
./build.sh {MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 4. Test Changes Locally
|
||||
|
||||
Test the changes thoroughly on the version branch to ensure everything works as expected:
|
||||
This will:
|
||||
1. Create a build directory
|
||||
2. Install composer dependencies
|
||||
3. Copy required files to the build directory
|
||||
4. Create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip`
|
||||
5. Deploy the plugin to your local WordPress testing environment
|
||||
|
||||
Test the plugin thoroughly in your local WordPress environment:
|
||||
- Test with the latest WordPress version
|
||||
- Test with PHP 7.0+ (minimum supported version)
|
||||
- Verify all features work as expected
|
||||
- Check for any PHP warnings or notices
|
||||
- Test any specific changes made in this version
|
||||
|
||||
### 5. Merge to Main
|
||||
### 4. Commit Changes
|
||||
|
||||
When satisfied with testing, merge the version branch to main:
|
||||
```bash
|
||||
git add wp-fix-plugin-does-not-exist-notices.php CHANGELOG.md README.md readme.txt languages/wp-fix-plugin-does-not-exist-notices.pot
|
||||
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
Note: Make sure to include README.md in your commit to keep all changelog files in sync.
|
||||
|
||||
### 5. Create a Tag
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
|
||||
```
|
||||
|
||||
### 6. Push Branch and Tag to Remotes
|
||||
|
||||
```bash
|
||||
# Push the branch
|
||||
git push github feature/branch-name
|
||||
git push gitea feature/branch-name
|
||||
|
||||
# Push the tag
|
||||
git push github v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 7. Verify GitHub Release
|
||||
|
||||
Check that the GitHub release was created successfully with the ZIP file attached:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases
|
||||
|
||||
If the release doesn't appear or doesn't have the ZIP file attached, check the GitHub Actions page:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions
|
||||
|
||||
### 8. Merge to Main (CRITICAL STEP)
|
||||
|
||||
**IMPORTANT**: This step is critical for Git Updater to detect the new version. Git Updater reads the readme.txt file from the main branch, not from tags or releases.
|
||||
|
||||
Merge the feature branch to main immediately after pushing the tag:
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
|
||||
```
|
||||
|
||||
The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.
|
||||
|
||||
### 6. Push Main to Remotes
|
||||
|
||||
```bash
|
||||
git merge feature/branch-name --no-ff
|
||||
git push github main
|
||||
git push gitea main
|
||||
```
|
||||
|
||||
### 7. Create and Push Tag
|
||||
The `--no-ff` flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.
|
||||
|
||||
```bash
|
||||
git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Release version {MAJOR}.{MINOR}.{PATCH}"
|
||||
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH}
|
||||
```
|
||||
|
||||
### 8. Monitor GitHub Actions
|
||||
|
||||
Open the GitHub Actions page to monitor the build and deployment process:
|
||||
https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/actions
|
||||
**Note**: Only use named branches like feature/*, fix/*, etc. for development. Release branches (v*) should always be merged to main immediately after tagging to ensure Git Updater can detect the new version.
|
||||
|
||||
### 9. Verify Release
|
||||
|
||||
- [ ] Check that the GitHub release was created successfully
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org
|
||||
- [ ] Test the plugin from WordPress.org to ensure it works correctly
|
||||
- [ ] Check that the GitHub release was created successfully with the ZIP file attached
|
||||
- [ ] Verify that the plugin was deployed to WordPress.org (if applicable)
|
||||
- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
|
||||
- [ ] Verify that Git Updater can detect and install the new version
|
||||
- [ ] Confirm that all changelog files (README.md, readme.txt, and CHANGELOG.md) are in sync
|
||||
|
||||
## Testing Previous Versions
|
||||
|
||||
|
||||
15
.github/workflows/release.yml
vendored
15
.github/workflows/release.yml
vendored
@ -28,10 +28,21 @@ jobs:
|
||||
cp readme.txt build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp LICENSE build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp README.md build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp -r assets build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp -r admin build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp -r includes build/wp-fix-plugin-does-not-exist-notices/
|
||||
cp -r languages build/wp-fix-plugin-does-not-exist-notices/
|
||||
|
||||
# Copy directories if they exist
|
||||
if [ -d "assets" ]; then
|
||||
cp -r assets build/wp-fix-plugin-does-not-exist-notices/
|
||||
fi
|
||||
|
||||
if [ -d "languages" ]; then
|
||||
cp -r languages build/wp-fix-plugin-does-not-exist-notices/
|
||||
fi
|
||||
|
||||
if [ -d ".wordpress-org" ]; then
|
||||
cp -r .wordpress-org build/wp-fix-plugin-does-not-exist-notices/
|
||||
fi
|
||||
|
||||
- name: Create ZIP file
|
||||
run: |
|
||||
|
||||
13
CHANGELOG.md
13
CHANGELOG.md
@ -1,5 +1,18 @@
|
||||
All notable changes to this project should be documented both here and in the main Readme files.
|
||||
|
||||
#### [2.2.2-stable] - 2025-04-14
|
||||
#### Changed
|
||||
- Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
- Removed redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
- Improved documentation for Git Updater integration and release process
|
||||
- Fixed token-efficient documentation with references to .ai-workflows files
|
||||
- Added comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
#### [2.2.1] - 2025-04-14
|
||||
#### Changed
|
||||
- Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
- Fixed version consistency across all files
|
||||
|
||||
#### [2.2.0] - 2025-04-14
|
||||
#### Added
|
||||
- Completely refactored plugin to use OOP best practices
|
||||
|
||||
23
README.md
23
README.md
@ -209,6 +209,29 @@ The plugin works by:
|
||||
3. Adding helpful notifications near error messages
|
||||
4. Providing a secure method to remove plugin references from the database
|
||||
|
||||
### Git Updater Integration
|
||||
|
||||
This plugin is designed to work seamlessly with the Git Updater plugin for updates from GitHub and Gitea. To ensure proper integration:
|
||||
|
||||
1. **Required Headers**: The plugin includes specific headers in the main plugin file that Git Updater uses to determine update sources and branches:
|
||||
```php
|
||||
* GitHub Plugin URI: wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* GitHub Branch: main
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* Gitea Branch: main
|
||||
```
|
||||
|
||||
2. **Tagging Releases**: When creating a new release, always tag it with the 'v' prefix (e.g., `v2.2.0`) to ensure GitHub Actions can create the proper release assets.
|
||||
|
||||
3. **GitHub Actions**: The repository includes a GitHub Actions workflow that automatically builds the plugin and creates a release with the .zip file when a new tag is pushed.
|
||||
|
||||
4. **Update Source Selection**: The plugin includes a feature that allows users to choose their preferred update source (WordPress.org, GitHub, or Gitea).
|
||||
|
||||
For more information on Git Updater integration, see the [Git Updater Required Headers documentation](https://git-updater.com/knowledge-base/required-headers/).
|
||||
|
||||
## Changelog
|
||||
|
||||
### 2.2.0
|
||||
|
||||
@ -1,75 +0,0 @@
|
||||
/**
|
||||
* Fix Plugin Version Display
|
||||
*
|
||||
* This script directly modifies the plugin details popup to show the correct version
|
||||
* when the popup is opened for our plugin.
|
||||
*/
|
||||
(function($) {
|
||||
'use strict';
|
||||
|
||||
// Current plugin version - this should match the version in the main plugin file
|
||||
const CURRENT_VERSION = '2.2.0';
|
||||
|
||||
// Plugin slugs to check for
|
||||
const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'];
|
||||
|
||||
// Function to fix the version in the plugin details popup
|
||||
function fixPluginDetailsVersion() {
|
||||
// Check if we're on the plugins page
|
||||
if (window.location.href.indexOf('plugins.php') === -1) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Wait for the thickbox to be initialized
|
||||
$(document).on('tb_init', function() {
|
||||
// Set a timeout to allow the thickbox content to load
|
||||
setTimeout(function() {
|
||||
// Get the thickbox iframe
|
||||
const $iframe = $('#TB_iframeContent');
|
||||
if (!$iframe.length) return;
|
||||
|
||||
// Wait for iframe to load
|
||||
$iframe.on('load', function() {
|
||||
try {
|
||||
const iframeDoc = this.contentDocument || this.contentWindow.document;
|
||||
|
||||
// Get the plugin title from the iframe
|
||||
const $title = $(iframeDoc).find('h2.plugin-title');
|
||||
if (!$title.length) return;
|
||||
|
||||
// Check if this is our plugin
|
||||
const titleText = $title.text();
|
||||
if (titleText.indexOf('Fix \'Plugin file does not exist\' Notices') !== -1) {
|
||||
console.log('Found our plugin in the details popup, fixing version...');
|
||||
|
||||
// Find the version element
|
||||
const $version = $(iframeDoc).find('.plugin-version-author-uri');
|
||||
if ($version.length) {
|
||||
// Update the version text
|
||||
const versionText = $version.text();
|
||||
const newVersionText = versionText.replace(/Version: [0-9.]+|Version: 0\.0\.0/, 'Version: ' + CURRENT_VERSION);
|
||||
$version.text(newVersionText);
|
||||
console.log('Updated version to: ' + CURRENT_VERSION);
|
||||
}
|
||||
|
||||
// Also update the version in the header if it exists
|
||||
const $versionHeader = $(iframeDoc).find('.wrap h2:contains("Version:")');
|
||||
if ($versionHeader.length) {
|
||||
$versionHeader.text('Version: ' + CURRENT_VERSION);
|
||||
console.log('Updated version header to: ' + CURRENT_VERSION);
|
||||
}
|
||||
}
|
||||
} catch (e) {
|
||||
console.error('Error updating plugin version:', e);
|
||||
}
|
||||
});
|
||||
}, 500);
|
||||
});
|
||||
}
|
||||
|
||||
// Initialize when the document is ready
|
||||
$(document).ready(function() {
|
||||
fixPluginDetailsVersion();
|
||||
});
|
||||
|
||||
})(jQuery);
|
||||
@ -45,7 +45,9 @@ class Admin {
|
||||
return;
|
||||
}
|
||||
|
||||
// Always load our version fix script on the plugins page
|
||||
// Version fix script is no longer needed after refactoring
|
||||
// Commented out for testing
|
||||
/*
|
||||
wp_enqueue_script(
|
||||
'fpden-version-fix',
|
||||
FPDEN_PLUGIN_URL . 'admin/js/version-fix.js',
|
||||
@ -53,6 +55,7 @@ class Admin {
|
||||
FPDEN_VERSION,
|
||||
true // Load in footer
|
||||
);
|
||||
*/
|
||||
|
||||
// Get invalid plugins to decide if other assets are needed
|
||||
$invalid_plugins = $this->core->get_invalid_plugins();
|
||||
|
||||
@ -142,152 +142,17 @@ class Plugin {
|
||||
/**
|
||||
* Initialize Git Updater fixes
|
||||
*
|
||||
* This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches
|
||||
* This function previously added filters to fix Git Updater's handling of 'main' vs 'master' branches.
|
||||
* These fixes are no longer needed with proper plugin headers.
|
||||
* See: https://git-updater.com/knowledge-base/required-headers/
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function init_git_updater_fixes() {
|
||||
// Fix for Git Updater looking for 'master' branch instead of 'main'
|
||||
add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3);
|
||||
|
||||
// Fix for Git Updater API URLs
|
||||
add_filter('gu_get_repo_api', array($this, 'override_api_url'), 999, 3);
|
||||
|
||||
// Fix for Git Updater download URLs
|
||||
add_filter('gu_download_link', array($this, 'override_download_link'), 999, 3);
|
||||
|
||||
// Fix for Git Updater repository metadata
|
||||
add_filter('gu_get_repo_meta', array($this, 'override_repo_meta'), 999, 2);
|
||||
|
||||
// Fix for Git Updater API responses
|
||||
add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3);
|
||||
// No fixes needed - we're using the proper plugin headers
|
||||
// Git Updater reads version information from the readme.txt file in the main branch
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the branch name for our plugin
|
||||
*
|
||||
* @param string $branch The current branch name
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return string The modified branch name
|
||||
*/
|
||||
public function override_branch($branch, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the branch unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $branch;
|
||||
}
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
return 'main';
|
||||
}
|
||||
return $branch;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the API URL for our plugin
|
||||
*
|
||||
* @param mixed $api_url The current API URL (can be string or object)
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return mixed The modified API URL (same type as input)
|
||||
*/
|
||||
public function override_api_url($api_url, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the URL unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
// Check if this is our plugin
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Only apply str_replace if $api_url is a string
|
||||
if (is_string($api_url)) {
|
||||
return str_replace('/master/', '/main/', $api_url);
|
||||
}
|
||||
|
||||
// If $api_url is an object, just return it unchanged
|
||||
// This handles the case where Git Updater passes a GitHub_API object
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
// Return unchanged if not our plugin
|
||||
return $api_url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the download link for our plugin
|
||||
*
|
||||
* @param string $download_link The current download link
|
||||
* @param string $git The git service (github, gitlab, etc.)
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return string The modified download link
|
||||
*/
|
||||
public function override_download_link($download_link, $git, $repo = null) {
|
||||
// If repo is null or not an object, just return the link unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $download_link;
|
||||
}
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
return str_replace('/master.zip', '/main.zip', $download_link);
|
||||
}
|
||||
return $download_link;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override repository metadata for our plugin
|
||||
*
|
||||
* @param array $repo_meta The repository metadata
|
||||
* @param object $repo The repository object
|
||||
* @return array The modified repository metadata
|
||||
*/
|
||||
public function override_repo_meta($repo_meta, $repo) {
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Set the correct repository information
|
||||
$repo_meta['github_updater_repo'] = 'wp-fix-plugin-does-not-exist-notices';
|
||||
$repo_meta['github_updater_branch'] = 'main';
|
||||
$repo_meta['github_updater_api'] = 'https://api.github.com';
|
||||
$repo_meta['github_updater_raw'] = 'https://raw.githubusercontent.com/wpallstars/wp-fix-plugin-does-not-exist-notices/main';
|
||||
}
|
||||
return $repo_meta;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override repository type data for our plugin
|
||||
*
|
||||
* @param array $data The repository data
|
||||
* @param object $response The API response
|
||||
* @param object|null $repo The repository object (optional)
|
||||
* @return array The modified repository data
|
||||
*/
|
||||
public function override_repo_type_data($data, $response, $repo = null) {
|
||||
// If repo is null or not an object, just return the data unchanged
|
||||
if (!is_object($repo)) {
|
||||
return $data;
|
||||
}
|
||||
|
||||
// Check if this is our plugin
|
||||
if (isset($repo->slug) &&
|
||||
(strpos($repo->slug, 'wp-fix-plugin-does-not-exist-notices') !== false ||
|
||||
strpos($repo->slug, 'fix-plugin-does-not-exist-notices') !== false)) {
|
||||
|
||||
// Set the correct branch
|
||||
if (isset($data['branch'])) {
|
||||
$data['branch'] = 'main';
|
||||
}
|
||||
|
||||
// Set the correct version
|
||||
if (isset($data['version'])) {
|
||||
$data['version'] = FPDEN_VERSION;
|
||||
}
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
// Git Updater override methods have been removed as they're no longer needed
|
||||
// We now use the proper plugin headers for Git Updater integration
|
||||
}
|
||||
|
||||
13
readme.txt
13
readme.txt
@ -5,7 +5,7 @@ Tags: plugins, missing plugins, cleanup, error fix, admin tools, plugin file doe
|
||||
Requires at least: 5.0
|
||||
Tested up to: 6.7.2
|
||||
Requires PHP: 7.0
|
||||
Stable tag: 2.2.0
|
||||
Stable tag: 2.2.2-stable
|
||||
License: GPL-2.0+
|
||||
License URI: https://www.gnu.org/licenses/gpl-2.0.html
|
||||
|
||||
@ -179,6 +179,17 @@ Manually editing the WordPress database is risky and requires technical knowledg
|
||||
|
||||
== Changelog ==
|
||||
|
||||
= 2.2.2-stable =
|
||||
* Changed: Renamed includes files to lowercase for consistency with the rest of the codebase
|
||||
* Removed: Redundant Git Updater patches and version-fix.js as they're no longer needed
|
||||
* Improved: Documentation for Git Updater integration and release process
|
||||
* Fixed: Token-efficient documentation with references to .ai-workflows files
|
||||
* Added: Comprehensive release process documentation with emphasis on merging to main branch
|
||||
|
||||
= 2.2.1 =
|
||||
* Changed: Commented out version-fix.js script as it's no longer needed after refactoring
|
||||
* Fixed: Version consistency across all files
|
||||
|
||||
= 2.2.0 =
|
||||
* Added: Completely refactored plugin to use OOP best practices
|
||||
* Added: New class structure with proper namespaces
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
* Plugin Name: Fix 'Plugin file does not exist' Notices
|
||||
* Plugin URI: https://www.wpallstars.com
|
||||
* Description: Adds missing plugins to your plugins list with a "Remove Notice" action link, allowing you to safely clean up invalid plugin references.
|
||||
* Version: 2.2.0
|
||||
* Version: 2.2.2-stable
|
||||
* Author: Marcus Quinn & The WPALLSTARS Team
|
||||
* Author URI: https://www.wpallstars.com
|
||||
* License: GPL-2.0+
|
||||
@ -15,8 +15,14 @@
|
||||
* Primary Branch: main
|
||||
* Release Branch: main
|
||||
* Release Asset: true
|
||||
* Requires at least: 5.0
|
||||
* Requires PHP: 7.0
|
||||
* Update URI: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
*
|
||||
* Gitea Plugin URI: https://gitea.wpallstars.com/wpallstars/wp-fix-plugin-does-not-exist-notices
|
||||
* Gitea Branch: main
|
||||
* Gitea Languages: languages
|
||||
*
|
||||
* @package WPALLSTARS\FixPluginDoesNotExistNotices
|
||||
*/
|
||||
|
||||
@ -29,4 +35,4 @@ if (!defined('WPINC')) {
|
||||
require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php';
|
||||
|
||||
// Initialize the plugin
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.0');
|
||||
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.2-stable');
|
||||
|
||||
Reference in New Issue
Block a user