Update release workflow documentation to reflect current best practices

.ai-assistant.md

@@ -70,11 +70,11 @@ We follow [Semantic Versioning](https://semver.org/):
 ### Version Update Checklist
 
 When updating the version number, always update these files:
-1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
+1. `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization)
 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
+5. Update any JavaScript files that contain version constants (e.g., `admin/js/version-fix.js`)
 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.
@@ -106,50 +106,55 @@ Before creating a new release, verify the following:
 
 ### Release Process
 
-1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}`
+1. Create a new branch for the version: `git checkout -b v{MAJOR}.{MINOR}.{PATCH}` or use an existing feature branch
 2. Update version numbers in ALL required files:
-   - `wp-fix-plugin-does-not-exist-notices.php` (Plugin header)
+   - `wp-fix-plugin-does-not-exist-notices.php` (Plugin header and version parameter in Plugin class initialization)
-   - `FPDEN_VERSION` constant in the main plugin file
+   - `readme.txt` (Stable tag and Changelog section)
-   - `readme.txt` (Stable tag)
+   - `CHANGELOG.md` (Add new version section at the top)
-   - `README.md` (Ensure changelog is updated)
+   - Any JavaScript files with version constants (e.g., `admin/js/version-fix.js`)
    - `languages/wp-fix-plugin-does-not-exist-notices.pot` (Project-Id-Version)
-   - Any other files that reference the version number
+3. Run the build script to create the plugin ZIP file and deploy to local testing environment:
-3. Update CHANGELOG.md with all changes
+   ```
-4. Update readme.txt changelog section
+   ./build.sh {MAJOR}.{MINOR}.{PATCH}
-5. Update README.md changelog section to match readme.txt
+   ```
-6. Commit changes: `git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"`
+4. Test the plugin thoroughly in the local WordPress environment
-7. Test changes locally on the version branch
+5. Commit changes: `git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"`
-8. When satisfied with testing, merge to main:
+6. Create a tag for the new version:
+   ```
+   git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
+   ```
+7. Push the branch and tag to all remotes:
+   ```
+   git push github feature/branch-name
+   git push gitea feature/branch-name
+   git push github v{MAJOR}.{MINOR}.{PATCH}
+   git push gitea v{MAJOR}.{MINOR}.{PATCH}
+   ```
+8. Verify the GitHub release is created with the ZIP file attached
+9. When ready to merge to main, create a pull request or merge directly:
    ```
    git checkout main
-   git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
+   git merge feature/branch-name --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
+1. Creates build directory
 2. Installs composer dependencies
-3. Copies files to build directory
+3. Copies required files to build directory
 4. Creates ZIP file
+5. Automatically deploys to local WordPress testing environment
 
-To manually build the plugin:
+To build the plugin and deploy to local testing:
 ```
 ./build.sh {MAJOR}.{MINOR}.{PATCH}
 ```
 
+This will create a ZIP file named `wp-fix-plugin-does-not-exist-notices-{MAJOR}.{MINOR}.{PATCH}.zip` and deploy the plugin to your local WordPress testing environment.
+
 ## Remote Repositories
 
 The plugin is hosted on multiple repositories:
@@ -205,37 +210,43 @@ cd ~/Local/plugin-testing/app/public
 ### Creating a New Release
 
 ```
-# 1. Create a new branch
+# 1. Start from a feature branch or create a new branch
-git checkout main
+git checkout feature/branch-name
-git checkout -b v1.7.0
+# or
+git checkout -b feature/new-feature-name
 
 # 2. Update version numbers in ALL required files
-# - wp-fix-plugin-does-not-exist-notices.php
+# - wp-fix-plugin-does-not-exist-notices.php (header and class initialization)
 # - CHANGELOG.md
-# - readme.txt
+# - readme.txt (Stable tag and Changelog section)
-# - README.md
+# - Any JavaScript files with version constants
 # - languages/wp-fix-plugin-does-not-exist-notices.pot
-# - FPDEN_VERSION constant
 
-# 3. Commit changes
+# 3. Build and test locally
+./build.sh 1.7.0
+# Test in local WordPress environment
+
+# 4. Commit changes
 git add .
-git commit -m "Prepare release v1.7.0"
+git commit -m "Version 1.7.0 - Brief description of changes"
 
-# 4. Test changes locally on the version branch
+# 5. Create a tag
-# (Run tests, verify functionality)
+git tag -a v1.7.0 -m "Version 1.7.0 - Brief description of changes"
 
-# 5. Merge to main when ready
+# 6. Push branch and tag to remotes
+git push github feature/branch-name
+git push gitea feature/branch-name
+git push github v1.7.0
+git push gitea v1.7.0
+
+# 7. Verify GitHub release is created with ZIP file
+# Check: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices/releases
+
+# 8. Merge to main when ready
 git checkout main
-git merge v1.7.0 --no-ff
+git merge feature/branch-name --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

.ai-workflows/release-process.md

@@ -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,49 @@ 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/
+ * Plugin URI: https://www.wpallstars.com
- * 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.
+ * 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
+Check for any JavaScript files that contain version constants, such as `admin/js/version-fix.js`:
-define( 'FPDEN_VERSION', '{MAJOR}.{MINOR}.{PATCH}' );
+
+```javascript
+// Current plugin version - this should match the version in the main plugin file
+const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}';
 ```
 
-#### b. CHANGELOG.md
+#### c. CHANGELOG.md
 
 Add a new section at the top of the CHANGELOG.md file:
 
 ```markdown
-## [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
+All notable changes to this project should be documented both here and in the main Readme files.
-### Added
-- New feature 1
-- New feature 2
 
-### Changed
+#### [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
+#### Added/Changed/Fixed
 - Change 1
 - Change 2
+- Change 3
 
-### Fixed
+#### [{PREVIOUS_VERSION}] - YYYY-MM-DD
-- Bug fix 1
-- Bug fix 2
 ```
 
-#### 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. 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 +99,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
+#### e. readme.txt
 
 Update the stable tag:
 
@@ -96,73 +111,84 @@ Add a new entry to the changelog section:
 
 ```
 = {MAJOR}.{MINOR}.{PATCH} =
-* New feature 1
-* New feature 2
 * Change 1
 * Change 2
-* Fixed bug 1
+* Change 3
-* Fixed bug 2
 ```
 
-Update the upgrade notice section:
+### 3. Build and Test Locally
 
-```
+Run the build script to create the plugin ZIP file and deploy to your local WordPress testing environment:
-= {MAJOR}.{MINOR}.{PATCH} =
-Brief description of the most important changes in this release
-```
-
-### 3. Commit Changes
 
 ```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
+./build.sh {MAJOR}.{MINOR}.{PATCH}
-git commit -m "Prepare release v{MAJOR}.{MINOR}.{PATCH}"
 ```
 
-### 4. Test Changes Locally
+This will:
-
+1. Create a build directory
-Test the changes thoroughly on the version branch to ensure everything works as expected:
+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.txt admin/js/version-fix.js languages/wp-fix-plugin-does-not-exist-notices.pot
+git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"
+```
+
+### 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 (When Ready)
+
+When you're satisfied with the release, merge the feature branch to main:
 
 ```bash
 git checkout main
-git merge v{MAJOR}.{MINOR}.{PATCH} --no-ff
+git merge feature/branch-name --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 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
 
 ### 9. Verify Release
 
-- [ ] Check that the GitHub release was created successfully
+- [ ] Check that the GitHub release was created successfully with the ZIP file attached
-- [ ] Verify that the plugin was deployed to WordPress.org
+- [ ] Verify that the plugin was deployed to WordPress.org (if applicable)
-- [ ] Test the plugin from WordPress.org to ensure it works correctly
+- [ ] Test the plugin from the GitHub release ZIP to ensure it works correctly
+- [ ] Verify that Git Updater can detect and install the new version
 
 ## Testing Previous Versions
 

.github/workflows/release.yml

@@ -40,6 +40,10 @@ jobs:
             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: |
           cd build

CHANGELOG.md

@@ -1,5 +1,10 @@
 All notable changes to this project should be documented both here and in the main Readme files.
 
+#### [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

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

admin/js/version-fix.js

@@ -8,7 +8,7 @@
     'use strict';
 
     // Current plugin version - this should match the version in the main plugin file
-    const CURRENT_VERSION = '2.2.0';
+    const CURRENT_VERSION = '2.2.1';
 
     // Plugin slugs to check for
     const OUR_SLUGS = ['wp-fix-plugin-does-not-exist-notices', 'fix-plugin-does-not-exist-notices'];

includes/Admin.php

@@ -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();

includes/Plugin.php

@@ -143,10 +143,16 @@ class Plugin {
      * Initialize Git Updater fixes
      *
      * This function adds filters to fix Git Updater's handling of 'main' vs 'master' branches
+     * Note: This fix is commented out as we're now using the proper plugin headers instead.
+     * See: https://git-updater.com/knowledge-base/required-headers/
      *
      * @return void
      */
     private function init_git_updater_fixes() {
+        // These fixes are no longer needed with proper plugin headers
+        // Keeping the code commented for reference
+
+        /*
         // Fix for Git Updater looking for 'master' branch instead of 'main'
         add_filter('gu_get_repo_branch', array($this, 'override_branch'), 999, 3);
 
@@ -161,6 +167,7 @@ class Plugin {
 
         // Fix for Git Updater API responses
         add_filter('gu_api_repo_type_data', array($this, 'override_repo_type_data'), 999, 3);
+        */
     }
 
     /**

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.1
 License: GPL-2.0+
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
@@ -179,6 +179,10 @@ Manually editing the WordPress database is risky and requires technical knowledg
 
 == Changelog ==
 
+= 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

wp-fix-plugin-does-not-exist-notices.php

@@ -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.1
  * 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.1');

wp-fix-plugin-does-not-exist-notices.php.bak

@@ -0,0 +1,32 @@
+<?php
+/**
+ * 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
+ * Author: Marcus Quinn & The WPALLSTARS Team
+ * Author URI: https://www.wpallstars.com
+ * License: GPL-2.0+
+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
+ * Text Domain: wp-fix-plugin-does-not-exist-notices
+ * Domain Path: /languages
+ * GitHub Plugin URI: wpallstars/wp-fix-plugin-does-not-exist-notices
+ * GitHub Branch: main
+ * Primary Branch: main
+ * Release Branch: main
+ * Release Asset: true
+ * Update URI: https://github.com/wpallstars/wp-fix-plugin-does-not-exist-notices
+ *
+ * @package WPALLSTARS\FixPluginDoesNotExistNotices
+ */
+
+// If this file is called directly, abort.
+if (!defined('WPINC')) {
+    die;
+}
+
+// Load the main plugin class
+require_once plugin_dir_path(__FILE__) . 'includes/Plugin.php';
+
+// Initialize the plugin
+new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '2.2.0');