Skip to content

V2 Release Procedure

Barry O'Donovan edited this page Feb 11, 2014 · 1 revision

Applies to ViMbAdmin v2 only! Deprecated in favour of ViMbAdmin v3.


For our Git workflow, we follow the scheme described in: http://nvie.com/posts/a-successful-git-branching-model/.

To create a new relase, proceed as follows:

Database Migrations

If there are database migrations, ensure you have:

  • noted this in the CHANGELOG
  • increased the minor version
  • updated the application.ini.dist migration_version parameter in [production] to the latest migration.

Creating a New Release

$ git checkout -b release-0.3 develop

$ joe library/ViMbAdmin/Version.php
(now edit the version and save)

$ library/Minify/minify.php --conf bin/minify-options.php --version X

$ git commit -a -m "Bumped version number to 0.3"

Update the CHANGELOG for the new release.

Once you're happy to release:

$ git checkout master
$ git merge --no-ff release-0.3
$ git tag -a 0.3
$ git push origin master
$ git push --tags 

To keep the changes made in the release branch, we need to merge those back into develop, though. In Git:

$ git checkout develop
$ git merge --no-ff release-0.3

This step may well lead to a merge conflict (probably even, since we have changed the version number). If so, fix it and commit.

We again need to push these to the canonical repository:

$ git push origin develop

Now we are really done and the release branch may be removed, since we don’t need it anymore:

$ git branch -d release-0.3

Now create a package for downloaders:

git archive --format=tar --prefix=vimbadmin-0.3/ master | gzip -9 >~/tmp/vimbadmin-0.3.tar.gz

and upload it to the Downloads section of GitHub.

Announcing the Release

ViMbAdmin will alert administrators of new releases on log in. For this, you need to update:

http://www.opensolutions.ie/open-source/vimbadmin/latest