WordPress.org

Ready to get started?Download WordPress

Forums

Releasing a Plugin Update (5 posts)

  1. jamesckemp
    Member
    Posted 2 years ago #

    I will soon be releasing a new version of one of my plugins. This is a major release, changing the version number to v2.0.

    The codebase has been completely re-written, including all the function names. I am concerned that anyone using the current version who updates will break their site.

    What is the best way of releasing this update, whilst maybe offering a warning to existing users to be aware that when they update they will need to change the template codes they are using and set it up again?

    Should I release it as a new plugin instead?

    Thanks in advance.

  2. esmi
    Forum Moderator
    Posted 2 years ago #

    There is supposed to be something you can add within the readme.txt file that you can use to warn users - so you could check on that. When we had a similar situation with the eShop plugin, we added a function to the current version of the plugin that started to flag up warnings about future updates.

  3. First make sure you use the changelog

    == Changelog ==
    
    = Version 2.0 =
    
    This is a major release that changes everythign!

    Then add an Upgrade Notice :)

    == Upgrade Notice ==
    
    = 1.0 =
    Upgrade notices describe the reason a user should upgrade.  No more than 300 characters.
    
    = 0.5 =
    This version fixes a security related bug.  Upgrade immediately.
  4. jamesckemp
    Member
    Posted 2 years ago #

    Cheers guys,

    Ipstenu - will this be noticeable when upgrading through the admin area? For example, you see some plugins with html lists and longer descriptions as an upgrade notice (in the yellow bubble).

  5. If you do the Upgrade Notice it should be.

Topic Closed

This topic has been closed to new replies.

About this Topic