[Biopython-dev] Travis-CI to complement BuildBot
Peter Cock
p.j.a.cock at googlemail.com
Fri Jun 22 08:48:12 UTC 2012
On Fri, Jun 22, 2012 at 1:36 AM, Brad Chapman <chapmanb at 50mail.com> wrote:
>
> Peter and Sergei;
>
>>> Great! can you add build status to the README.md file, so
>>> anyone can see if 'master' is okay to use?
>
>> The Travis (and BuildBot) status is something of interest to people
>> on the development list certainly - but I doubt most people looking
>> at the README file would care (this includes people who have
>> downloaded a release, not just those browsing on github).
>
> I'd second Sergei's suggestion. It's useful information, shows up as a
> small image in the readme on GitHub, and provides a link to the Travis
> CI builds. Here's an example from one of my own projects:
>
> https://github.com/chapmanb/bcbio.variation#readme
>
> You only need this little magic in the README:
>
> [![Build Status](https://secure.travis-ci.org/biopython/biopython.png)](http://travis-ci.org/biopython/biopython)
Maybe a little more magic to restrict it to the master branch...
which makes the image URL longer - but that isn't the most
beautiful lump of text for a plain text README file is it?
I almost wonder if README and README.md should be
different, one the instructions to go with the source code,
and the other a second home page to show on github.
It is a shame that (as far as I know) markdown doesn't let
you @include another file - then we could have a fancy
README.md pulling in the original plainer README.
Peter
More information about the Biopython-dev
mailing list