Difference between revisions of "WikiDB/Versioning"
(Moved from WikiDB and updated.) |
m (Tweak) |
||
| Line 3: | Line 3: | ||
* The '''version''' number is incremented whenever changes are made that require changes 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 data on the wiki. When upgrading to a newer version where the version number has changed, you will need to run the appropriate maintenance scripts (as described on the [[WikiDB/Changes|changes]] page) in order to update your database. Your wiki may not work as expected until these scripts have been run. | * The '''version''' number is incremented whenever changes are made that require changes 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 data on the wiki. When upgrading to a newer version where the version number has changed, you will need to run the appropriate maintenance scripts (as described on the [[WikiDB/Changes|changes]] page) in order to update your database. Your wiki may not work as expected until these scripts have been run. | ||
| − | * The '''revision''' number is incremented 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. This is displayed on the [[Special:Version]] page, for ease of reference. | + | * The '''revision''' number is incremented 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. This is displayed on the [[Special:Version]] page, for ease of reference. When upgrading, you should not need to run any upgrade scripts if only the revision number (and not the version) has changed. |
In both cases, the only significance of the numbers are that higher numbers are newer. I don't believe in sitting on a 0.x release branch for the rest of my life, so the first version I released was called v1, and the number is updated as often as necessary according to the above rules. | In both cases, the only significance of the numbers are that higher numbers are newer. I don't believe in sitting on a 0.x release branch for the rest of my life, so the first version I released was called v1, and the number is updated as often as necessary according to the above rules. | ||
Revision as of 03:35, 28 September 2010
The version-numbering system I have adopted for WikiDB is based on two numbers:
- The version number is incremented whenever changes are made that require changes 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 data on the wiki. When upgrading to a newer version where the version number has changed, you will need to run the appropriate maintenance scripts (as described on the changes page) in order to update your database. Your wiki may not work as expected until these scripts have been run.
- The revision number is incremented 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. This is displayed on the Special:Version page, for ease of reference. When upgrading, you should not need to run any upgrade scripts if only the revision number (and not the version) has changed.
In both cases, the only significance of the numbers are that higher numbers are newer. I don't believe in sitting on a 0.x release branch for the rest of my life, so the first version I released was called v1, and the number is updated as often as necessary according to the above rules.
Finding the version number
The version number can be seen on the Special:Version page on your wiki. If your version of the code doesn't have a version number, it is v1. If it doesn't have a revision either, it is very old and should definitely be updated!
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.
