How-To: Release MediaWiki extension {$extension} v{$version}

When releasing a MediaWiki extension you need to check in the code, create a release tag, write an updated documentation and version updates to extension page on MediaWiki.org and promote new release

Steps

  1. Test the code
    Before releasing the code, test it thoroughly on your system and maybe some other test instances.
  2. Make sure no bugs are blocking
    Check bugzilla if there are any bugs that block the release and fix them.
  3. Increment extension version in $wgExtensionCredits
    Increment extension version in $wgExtensionCredits to next -dev version so Special:Version page can show it when person exports from SVN trunk.

    Even if it's a minor change, increment the version as it'll help users to see the progress and for you to be able to debug problems more precisely.
  4. Check in extension code into repository
    Whatever you're using Wikimedia repository or not, check the code into repository before releasing it.

    Check what you did by running
    svn diff
    Then run
    svn ci -m "{$description}"
  5. Make a release tag and upload packages to Google Code
    Remove -dev from extension version in $wgExtensionCredits (only in a local copy).

    Run make to make release tag and upload packages to Google Code.
    make rel v={$version}
    You'll need your SVN username and password to upload.

    Message:

              {$description}

     
  6. Update extension page
    Go to extension page on MediaWiki.org and update it's content to reflect the changes including extension version, SVN release URL (the one you tagged), release notes.

    Release message / comment: Release {$version}: {$description}

    Version: {$version}
  7. Post a message to a Google Group

    Copy release notes into an email and send it to mailing list indicating where to get a new version (e.g. SVN Release tag), why people should be upgrading (e.g. security fixes) and so on. Don't forget to mention release version in email subject.
    ---------------------------------

    Subject: Release {$version}: {$description}


                         .... add more descriptive text ...


    To upgrade using Subversion, type:

             svn update

    or using a tag:

             svn switch http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/{$extension.urlencoded}/REL_{$version-underscores}/

    If you don't like dealing with Subversion, you can also download packaged versions:

             http://mediawiki-widgets.googlecode.com/files/{$extension.urlencoded}_{$version.urlencoded}.tgz
             http://mediawiki-widgets.googlecode.com/files/{$extension.urlencoded}_{$version.urlencoded}.zip

    Let me know if you'll have any troubles upgrading {$extension} or configuring it.

    For more information about installation, check out extension page on MediaWiki:
    http://www.mediawiki.org/wiki/Extension:{$extension}#Installation

    Don't forget that your bugs and feature requests are welcome in Bugzilla:
    https://bugzilla.wikimedia.org/enter_bug.cgi?product=MediaWiki+extensions&component={$bugzilla-component}

    Thank you,

                Sergey


    --
    htto://www.sergeychernyshev.com/