/ 
Dist-Zilla-Plugin-JSAN-0.01_02
River stage zero No dependents
/ Dist::Zilla::Plugin::JSAN

NAME

Dist::Zilla::Plugin::JSAN - a plugin for Dist::Zilla for building JSAN distributions

VERSION

version 0.01_02

SYNOPSIS

In dist.ini:

name                = Sample-Dist
abstract            = Some clever yet compact description

author              = Clever Guy
license             = LGPL_3_0
copyright_holder    = Clever Guy


; version provider
[BumpVersionFromGit]
first_version = 0.01 


; choose/generate files to include

[GatherDir]
[PruneCruft]
[ManifestSkip]
[License]


; build system

[ExecDir]
[ShareDir]


; JSAN-specific configuration
[JSAN]                            ; includes META.JSON generation
docs_markup         = mmd         ; default
static_dir          = static      ; default

[JSAN::ReadmeFromMD]              ; should be after docs generation
[JSAN::InstallInstructions]       ; add INSTALL file, describing the installation process
[JSAN::Bundle]                    ; after docs generation to avoid docs for bundles

; manifest (after all generated files)
[Manifest]


; before release

[Git::Check]
[CheckChangesHasContent]

; [TestRelease] todo
[ConfirmRelease]

; releaser
[JSAN::Upload]  ; just a no-op for now
 
 
; after release
[Git::Commit / Commit_Dirty_Files]
 
[Git::Tag]
 
[NextRelease]
format = %-9v %{yyyy-MM-dd HH:mm}d

[Git::Commit / Commit_Changes]
 
[Git::Push]
push_to = origin

[Twitter]
tweet_url     = http://openjsan.org/go/?l={{ '{{ my $dist = $DIST; $dist =~ s/-/./g; $dist; }}' }}
tweet         = Released {{ '{{$DIST}}-{{$VERSION}} {{$URL}}' }}
hash_tags     = #jsan
   
; prerequisites

[JSAN::Prereq]
Joose                         = 3.010
Cool.Module                   = 0.01

DESCRIPTION

This is a plugin for distribution-management tool Dist::Zilla. It greatly simplifies the release process, allowing you to focus on the code itself.

As the installer, this plugin use Module::Build::JSAN::Installable, please RTFM.

PLUGINS

Any usual Dist::Zilla plugins can be used. In the SYNOPSIS above we've used Dist::Zilla::Plugin::Git::Check and Dist::Zilla::Plugin::CheckChangesHasContent. Additionally several JSAN-specific plugins were added:

Dist::Zilla::Plugin::JSAN::ReadmeFromMD - copies a main documentation file to the distribution root as README.md

Dist::Zilla::Plugin::JSAN::InstallInstructions - generates INSTALL file in the root of distribution with installation instructions

Dist::Zilla::Plugin::JSAN::Bundle - concatenate individual source files into bundles, based on information from Components.JS file

Dist::Zilla::Plugin::JSAN::Prereq - allows you to specify the dependencies for the distribution, using dot as namespace separator

STARTING A NEW DISTRIBUTION

This plugin allows you to easily start a new JSAN distribution. Read to Dist::Zilla::Plugin::JSAN::Minter know how.

AUTHOR

Nickolay Platonov, <nplatonov at cpan.org>

BUGS

Please report any bugs or feature requests to http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dist-Zilla-Plugin-JSAN or http://github.com/SamuraiJack/Dist-Zilla-Plugin-JSAN/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

This module is stored in an open repository at the following address:

http://github.com/SamuraiJack/Dist-Zilla-Plugin-JSAN

COPYRIGHT & LICENSE

Copyright 2010 Nickolay Platonov, all rights reserved.

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

AUTHOR

Nickolay Platonov <nplatonov@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Nickolay Platonov.

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