WikiDB/Versioning

From TestWiki
< WikiDB
Revision as of 02:57, 28 September 2010 by HappyDog (Talk | contribs) (Rewrite)

Jump to: navigation, search

I don't believe in sitting on a 0.x release branch for the rest of my life. Furthermore, as I am in the habit of releasing changes as they are made it doesn't make sense to have to manually update the version number every time I update the code.

Therefore, the version-numbering system I have adopted for WikiDB is based on two numbers:

  • The version number is an integer which is incremented manually whenever changes are made that require modifications to the internal database. This includes changes to the internal schema, and any changes to the way data is stored that may require reparsing existing pages of the wiki.
  • The revision number is incremented automatically every time I make any changes at all to the code or to other unrelated code that sits in the same repository. The revision number for each file can be seen at the top of the file, and the revision number for the extension is the highest of these numbers.

Finding the version number

The version number can be seen on the Special:Version page on your wiki. If your installation doesn't display a version number, it is v1. If it doesn't have a revision either, it is very old and you should definitely upgrade!

Version numbers and upgrades

When upgrading WikiDB, you should check the version number to decide whether any maintenance scripts need to be run.

  • If the version number has changed then you will need to run one or more maintenance scripts to upgrade your stored data to work with the latest version. Be warned - if you upgrade the extension's code without also updating your data, your wiki is liable to break, albeit temporarily. The details for any particular version upgrade are described on the changes page.
  • If the version number has not changed, then you don't need to run any scripts - just copy the files into place.

See WikiDB/Upgrading for more info.

Let me know what you're using!

If you are a user of the extension, it would be very useful if you could add yourself to the compatibility page. This allows me to keep an eye of what versions of WikiDB are currently in use and, more importantly, what versions of MediaWiki. This helps me decide which older versions I might need to support if I decide to upgrade the minimum requirements, and where I should focus my testing.