History

Хорошим тоном является ведение истории изменения версий провайдеров. Тогда пользователи будут знать, какие преимущества и новые возможности они получают при установке новой версии провайдера.

Для этого в провайдер надо добавить файл history.xml, прописать его в раздел files манифеста под тэгом history. При внесении изменений в провайдер и увеличении его версии в файл history.xml нужно кратко записать, какие изменения были сделаны.

Файл истории имеет следующую структуру

<?xml version="1.0" encoding="utf-8"?>
<history>
    <change major_version="1.2" version="18" date="2012-07-07">
      - Исправлен для ведения истории версий
    </change>
    <change major_version="1.1" version="17">
      - Отображение ошибки при проблемах с сайтом
    </change>
    <change major_version="1.1" version="16">
      - Отображение трафика числовым счетчиком (в Мб). Чтобы отображался, надо выбрать счетчик заново.
    </change>
</history>

Как видно, это просто перечисление тэгов change, каждый из которых содержит информацию об изменениях в версии, указанной в атрибуте version. В теле тэга change прописывается просто текстом суть изменений.

change может содержать следующие атрибуты

• version - обязательный атрибут (целое число), указывает версию провайдера, изменения для которой содержатся в данном change. Должен соответствовать атрибуту version тэга id манифеста.
• major_version - текстовая часть версии, которая была в той версии провайдера, изменения для которой описываются. Соответствует атрибуту major_version тэга id манифеста. Необязательный атрибут. Стоит указывать, если в манифесте прописана текстовая часть версии.
• date - дата изменения версии. В формате YYYY-MM-DD. Необязательный атрибут.