Development

Information, resources and conventions concerning cherrymusic development

master
devel

Continuous Integration

[travis-ci] (http://about.travis-ci.org/docs/) tests certain branches after commits to github. .travis.yml contains the relevant configuration.
travis provides browser plugins to display project build status while browsing github. (for firefox, chrome and opera, currently.)

Release

Here's the recommended way to create a new release.

0. Make sure devel is up to date

    $ git checkout devel
    $ git pull
   

1. Merge devel into master

   The latest master commit should be in the history of devel, so this should be possible as a fast-forward merge. However, to preserve history correctly, it's better to have an explicit merge commit:

    $ git checkout master
    $ git merge --no-ff devel
   

2. Bump the version

   Decide on the new version number. Update CHANGES and the cherrymusicserver module accordingly.

    $ vim CHANGES
    $ vim cherrymusicserver/__init__.py
   

3. Create the release commit

    $ git commit -m "version X.Y.Z"
   

4. Tag the release commit

    $ git tag -a -m "vX.Y.Z"
   

5. Merge the release back into devel

    $ git checkout devel
    $ git merge master
   

6. Push everything to origin

    $ git checkout master
    $ git push --tags 
   

Github RSS Feeds

Useful news feeds to keep up to date

Personal news

After logging in, the github home page shows your personal news feed. On the same page, there's a link to the RSS feed of this stream, currently towards the top right corner. In general, it takes the form of

https://github.com/$USER.private.atom?token=$APITOKEN

There seems to be now way to find out one's API token without finding this RSS link.

Branch commits

generally: https://github.com/$USER/$REPOSITORY/commits/$BRANCH.atom

With diff: http://github-rss.heroku.com/?feed=$FEEDURL

master: https://github.com/devsnd/cherrymusic/commits/master.atom

devel: https://github.com/devsnd/cherrymusic/commits/devel.atom

Since cherrymusic is a public repository, there's no need for authentication.

Wiki

Changes: https://github.com/devsnd/cherrymusic/wiki.atom

API

designing RESTful web services