wpallstars/wp-fix-plugin-does-not-exist-notices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 15 Wiki Activity
Files
9afa732c2030147978d44833724b000a8c76b0c9
wp-fix-plugin-does-not-exis…/.ai-workflows/release-process.md

11 KiB
Raw Blame History

Release Process for AI Assistants

This document provides step-by-step instructions for AI assistants to help with the release process for the Fix Plugin Does Not Exist Notices plugin.

Pre-Release Checklist

  • All features for this release are complete
  • All bug fixes for this release are complete
  • CHANGELOG.md is up to date
  • readme.txt is up to date
  • README.md is up to date
  • Wiki documentation in the .wiki directory is up to date
  • All tests pass

Determining the New Version Number

Based on the changes made, determine the appropriate version increment:

  1. PATCH (e.g., 1.6.0 → 1.6.1): For bug fixes and minor improvements
  2. MINOR (e.g., 1.6.0 → 1.7.0): For new features and significant improvements
  3. MAJOR (e.g., 1.6.0 → 2.0.0): For breaking changes
    • Only increment when numerous features and fixes are tested and confirmed stable

IMPORTANT: For time-efficient development:

  • Use descriptive branches (fix/, feature/, patch/, refactor/) without version numbers during development
  • Don't update version numbers during initial development and testing
  • Only create version branches (e.g., v2.2.3) and update version numbers when changes are confirmed working

This approach allows focusing on the changes without worrying about version updates until they're ready for release.

For detailed guidelines on time-efficient development and testing, see @.ai-workflows/incremental-development.md.

Release Steps

1. Create a Version Branch

When changes are confirmed working and ready for release:

# First, ensure you have the latest main branch
git checkout main
git pull origin main

# Option 1: If you're coming from a development branch
git checkout fix/your-fix-branch  # or feature/your-feature-branch

# Option 2: Create a version branch directly from main
git checkout -b v{MAJOR}.{MINOR}.{PATCH}

Example:

git checkout main
git pull origin main

# If coming from a development branch
git checkout feature/add-new-selector

# Create the version branch
git checkout -b v2.3.0

IMPORTANT: The version branch is where you'll update all version numbers. This should only be done after the changes have been tested and confirmed working.

For more detailed git workflow guidelines, see @.ai-workflows/git-workflow.md.

2. Update Version Numbers

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:

/**
 * 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: {MAJOR}.{MINOR}.{PATCH}
 * ...
 */

// At the bottom of the file, update the version parameter:
new WPALLSTARS\FixPluginDoesNotExistNotices\Plugin(__FILE__, '{MAJOR}.{MINOR}.{PATCH}');

b. JavaScript Files with Version Constants

Check for any JavaScript files that might contain version constants:

// Current plugin version - this should match the version in the main plugin file
const CURRENT_VERSION = '{MAJOR}.{MINOR}.{PATCH}';

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:

All notable changes to this project should be documented both here and in the main Readme files.

#### [{MAJOR}.{MINOR}.{PATCH}] - YYYY-MM-DD
#### Added/Changed/Fixed
- Change 1
- Change 2
- Change 3

#### [{PREVIOUS_VERSION}] - YYYY-MM-DD

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:

## Changelog

### {MAJOR}.{MINOR}.{PATCH}
* Change 1
* Change 2
* Change 3

### {PREVIOUS_VERSION}

IMPORTANT: Always keep the changelogs in README.md, readme.txt, CHANGELOG.md, and .wiki/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!):

"Project-Id-Version: Fix 'Plugin file does not exist' Notices {MAJOR}.{MINOR}.{PATCH}\n"
"POT-Creation-Date: YYYY-MM-DDT00:00:00+00:00\n"

Note: Always use the current date for POT-Creation-Date in the format YYYY-MM-DD.

f. readme.txt

Update the stable tag:

Stable tag: {MAJOR}.{MINOR}.{PATCH}

Add a new entry to the changelog section:

= {MAJOR}.{MINOR}.{PATCH} =
* Change 1
* Change 2
* Change 3

g. Wiki Documentation (.wiki/Changelog.md)

Update the Changelog.md file in the .wiki directory to match the changes in CHANGELOG.md:

# Changelog

This page documents all notable changes to the "Fix 'Plugin file does not exist' Notices" plugin.

## Version {MAJOR}.{MINOR}.{PATCH} (YYYY-MM-DD)
- Change 1
- Change 2
- Change 3

## Version {PREVIOUS_VERSION} (YYYY-MM-DD)

Also update any other wiki pages that might be affected by the changes in this release, such as:

  • .wiki/Home.md (if major features were added)
  • .wiki/How-It-Works.md (if the internal workings changed)
  • .wiki/Frequently-Asked-Questions.md (if new FAQs were added)
  • Feature-specific pages (if features were added or modified)

For detailed guidelines on maintaining wiki documentation, see @.ai-workflows/wiki-documentation.md.

3. Build and Test

Local Testing (Default for Incremental Development)

For incremental development and testing, only local testing is required unless specifically requested:

./build.sh {MAJOR}.{MINOR}.{PATCH}

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
  • Verify all features work as expected
  • Check for any PHP warnings or notices
  • Test any specific changes made in this version

Remote Testing (When Specifically Requested)

When the user specifically requests remote testing, follow these additional steps after local testing:

  1. Commit changes to the remote repository
  2. Create and push a tag
  3. Verify that GitHub Actions builds the installable ZIP file
  4. Test the remotely built version

This is necessary when testing Git Updater integration or other features that require the plugin to be installed from a remote source.

4. Commit Changes

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 .wiki/Changelog.md
git commit -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"

Note: If you've updated other wiki pages, make sure to include them in the git add command as well.

Note: Make sure to include README.md in your commit to keep all changelog files in sync.

5. Create a Tag

git tag -a v{MAJOR}.{MINOR}.{PATCH} -m "Version {MAJOR}.{MINOR}.{PATCH} - Brief description of changes"

Marking a Version as Stable

When the user confirms that a version is working correctly and stable:

# Create a stable tag for easy reference
git tag -a v{MAJOR}.{MINOR}.{PATCH}-stable -m "Stable version {MAJOR}.{MINOR}.{PATCH}"

This provides a clear reference point for stable versions that can be used for rollbacks if needed.

6. Push Branch and Tag to Remotes

# 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:

git checkout main
git merge feature/branch-name --no-ff
git push github main
git push gitea main

The --no-ff flag creates a merge commit even if a fast-forward merge is possible, which helps preserve the branch history.

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 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, CHANGELOG.md, and .wiki/Changelog.md) are in sync
  • Verify that all wiki documentation is up to date and accurately reflects the changes in this release
  • Check that the wiki sync GitHub Action has run successfully (if changes were made to the .wiki directory)
  • Verify that all CI/CD checks have passed for the release

Testing Previous Versions

To test a previous version of the plugin:

# Checkout a specific tag for testing
git checkout v{MAJOR}.{MINOR}.{PATCH}

# Or create a test branch from a specific tag
git checkout v{MAJOR}.{MINOR}.{PATCH} -b test/some-feature

Rollback Procedure (If Needed)

If issues are discovered after release:

1. Create a Hotfix Branch

git checkout v{MAJOR}.{MINOR}.{PATCH}
git checkout -b hotfix/v{MAJOR}.{MINOR}.{PATCH+1}

2. Fix the Issues

Make the necessary changes to fix the issues.

3. Update Version Numbers

Increment the PATCH version and update all version numbers as described above.

4. Test the Hotfix

Test the hotfix thoroughly to ensure it resolves the issue without introducing new problems.

5. Commit Changes

git add .
git commit -m "Fix issues in v{MAJOR}.{MINOR}.{PATCH}"

6. Merge to Main

git checkout main
git merge hotfix/v{MAJOR}.{MINOR}.{PATCH+1} --no-ff
git push github main
git push gitea main

7. Create and Push Tag

git tag -a v{MAJOR}.{MINOR}.{PATCH+1} -m "Hotfix release version {MAJOR}.{MINOR}.{PATCH+1}"
git push github refs/tags/v{MAJOR}.{MINOR}.{PATCH+1}
git push gitea refs/tags/v{MAJOR}.{MINOR}.{PATCH+1}

8. Monitor and Verify

Follow steps 8 and 9 from the release process to monitor and verify the hotfix release.