Giter Site home page Giter Site logo

dist-zilla-plugin-travisci-statusbadge's Introduction

NAME

Dist::Zilla::Plugin::TravisCI::StatusBadge - Get Travis CI status badge for your markdown README

Build Status

VERSION

version 0.009

SYNOPSIS

; in dist.ini
[TravisCI::StatusBadge]
user = johndoe
repo = p5-John-Doe-Stuff
branch = foo        ;; "master" by default
vector = 1          ;; SVG image

; or just
[TravisCI::StatusBadge]
;; shortcut for "png image; master branch; user/repo from meta resources"

DESCRIPTION

Injects the Travis CI Build status badge before the VERSION header into any form of README.[md|pod] file.

Traget readme might be pointed via option "readme" or guessed by module.

Use Dist::Zilla::Plugin::ReadmeAnyFromPod in markdown mode or any other plugin to generate target file

[ReadmeAnyFromPod / ReadmeMdInRoot]
type     = markdown
filename = README.md
location = root

OPTIONS

readme

The name of file to inject build status badge. No default value but there is some logic to guess target filename. File can be named as README or Readme and has the one of following extensions: md, mkdn, markdown or pod.

In case of some name passed via this option, it will be used only if the target file exists otherwise will be checked default variations and used first found.

format

Either pod or markdown. Optional. When unspecified, format is pod if readme has a .pod file extension and markdown otherwise.

user

Github username. Might be obtained automatically (if not given) from META resources (resources.homepage, resources.repository.web, resources.repository.url).

repo

Github repository name. Might be obtained automatically (if not given) from META resources (resources.homepage, resources.repository.web, resources.repository.url).

branch

Branch name which build status should be shown. Optional. Default value is master.

vector

Use vector representation (SVG) of build status image. Optional. Default value is false which means using of the raster representation (PNG).

SEE ALSO

Please see those modules/websites for more information related to this module.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/Wu-Wu/Dist-Zilla-Plugin-TravisCI-StatusBadge/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Anton Gerasimov [email protected]

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Anton Gerasimov.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

dist-zilla-plugin-travisci-statusbadge's People

Contributors

a3f avatar skaji avatar wu-wu avatar

Watchers

 avatar  avatar

Forkers

skaji a3f

dist-zilla-plugin-travisci-statusbadge's Issues

tests fail on perl 5.25.10+ (including new perl 5.26.0)

Most tests fail like this:

Can't locate t/lib/Builder.pm in @INC (you may need to install the t::lib::Builder module) (@INC contains: /Volumes/amaretto/Users/ether/.cpanm/work/1493401060.8517/Dist-Zilla-Plugin-TravisCI-StatusBadge-0.006/blib/lib /Volumes/amaretto/Users/ether/.cpanm/work/1493401060.8517/Dist-Zilla-Plugin-TravisCI-StatusBadge-0.006/blib/arch /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5 /Volumes/amaretto/Users/ether/.cpanm/work/1493401060.8517/Dist-Zilla-Plugin-TravisCI-StatusBadge-0.006/blib/lib /Volumes/amaretto/Users/ether/.cpanm/work/1493401060.8517/Dist-Zilla-Plugin-TravisCI-StatusBadge-0.006/blib/arch /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/5.25.11 /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5/darwin-2level /Volumes/amaretto/Users/ether/.perlbrew/libs/25.11@std/lib/perl5 /Volumes/amaretto/Users/ether/perl5/perlbrew/perls/25.11/lib/site_perl/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/perl5/perlbrew/perls/25.11/lib/site_perl/5.25.11 /Volumes/amaretto/Users/ether/perl5/perlbrew/perls/25.11/lib/5.25.11/darwin-2level /Volumes/amaretto/Users/ether/perl5/perlbrew/perls/25.11/lib/5.25.11) at t/01-basic.t line 7.
BEGIN failed--compilation aborted at t/01-basic.t line 7.
t/01-basic.t .............. 
Dubious, test returned 2 (wstat 512, 0x200)
No subtests run 

..due to '.' being removed from @INC in new perl releases.

The best way to fix this would be to use lib 't/lib'; in relevant .t files, and changepackage t::lib::Builder; to package Builder;.

get repository URL and user name from Meta if possible

I would like to use this plugin, but I don't want to specify the repository by hand, since I already use the GithubMeta plugin to provide this information automatically. In my case this information is available programmatically, and it would be nice if some sane defaults were used.

The repository URL can be retrieved from the dist_meta method of Dist:;Zilla, and a default user name could be parsed out of a github URL pretty easily ('/github.com\/([^/]+)\//).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.