Permalink
Browse files

Bumped requirement versions, tuned documentation massivly

  • Loading branch information...
1 parent 2ab7b9b commit bc548ea4703ed028eabef9b0efb769a4726f03e7 @Getty committed Mar 2, 2013
Showing with 138 additions and 30 deletions.
  1. +15 −16 dist.ini
  2. +123 −14 lib/Dist/Zilla/PluginBundle/Author/GETTY.pm
View
@@ -7,23 +7,22 @@ copyright_year = 2012
[@Author::GETTY]
[Prereqs]
-Dist::Zilla = 1.092990 ; new-style bundle expansion
-Pod::Elemental = 0.092970
-Pod::Weaver = 3.100310 ; =func, compat fixes
-Dist::Zilla::Plugin::PodWeaver = 3.101641
-Dist::Zilla::Plugin::Repository = 0.19
-Dist::Zilla::Plugin::TaskWeaver = 0.101624
-Dist::Zilla::Plugin::BumpVersionFromGit = 0.009
-Dist::Zilla::Plugin::GithubMeta = 0.28
-Dist::Zilla::Plugin::InstallRelease = 0.007
+App::cpanminus = 1.6002
+Dist::Zilla = 4.300030
+Dist::Zilla::Plugin::Alien = 0.007
Dist::Zilla::Plugin::Authority = 1.006
+Dist::Zilla::Plugin::BumpVersionFromGit = 0.009
+Dist::Zilla::PluginBundle::Git = 2.009
Dist::Zilla::Plugin::ChangelogFromGit = 0.006
-Dist::Zilla::Plugin::UploadToDuckPAN = 0.001
+Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch = 0.006
+Dist::Zilla::Plugin::GithubMeta = 0.28
+Dist::Zilla::Plugin::InstallRelease = 0.008
Dist::Zilla::Plugin::MakeMaker::SkipInstall = 1.100
-Dist::Zilla::Plugin::Run = 0.014
-Dist::Zilla::PluginBundle::Git = 2.008
+Dist::Zilla::Plugin::PodWeaver = 3.101641
+Dist::Zilla::Plugin::Repository = 0.19
+Dist::Zilla::Plugin::Run = 0.018
+Dist::Zilla::Plugin::TaskWeaver = 0.101624
+Dist::Zilla::Plugin::UploadToDuckPAN = 0.002
+Pod::Elemental = 0.102362
Pod::Elemental::Transformer::List = 0.101620
-App::cpanminus = 1.5021
-
-[Prereqs / TestRequires]
-Test::More = 0.98
+Pod::Weaver = 3.101638
@@ -6,9 +6,34 @@ use Moose::Autobox;
use Dist::Zilla;
with 'Dist::Zilla::Role::PluginBundle::Easy';
+=head1 SYNOPSIS
+
+ name = Alien-ffmpeg
+ author = You User <you@universe.org>
+ license = Perl_5
+ copyright_holder = You User
+ copyright_year = 2013
+
+ [@Author::GETTY]
+ author = YOUONCPAN
+
=head1 DESCRIPTION
-This is the plugin bundle that GETTY uses. It is equivalent to:
+This is the plugin bundle that GETTY uses. You can configure it (given values
+are default):
+
+ [@Author::GETTY]
+ author = GETTY
+ release_branch = master
+ weaver_config = @Author::GETTY
+ no_cpan = 0
+ duckpan = 0
+ no_install = 0
+ no_makemaker = 0
+ no_installrelease = 0
+ installrelease_command = cpanm .
+
+In default configuration it is equivalent to:
[@Basic]
@@ -45,19 +70,6 @@ This is the plugin bundle that GETTY uses. It is equivalent to:
wrap_column = 74
debug = 0
-You can configure it (given values are default):
-
- [@Author::GETTY]
- author = GETTY
- release_branch = master
- weaver_config = @Author::GETTY
- no_cpan = 0
- duckpan = 0
- no_install = 0
- no_makemaker = 0
- no_installrelease = 0
- installrelease_command = cpanm .
-
If the C<task> argument is given to the bundle, PodWeaver is replaced with
TaskWeaver and Git::NextVersion is replaced with AutoVersion, you can also
give independent a bigger major version with C<version>:
@@ -83,6 +95,103 @@ You can also use shortcuts for integrating L<Dist::Zilla::Plugin::Run>:
run_if_release_test = ./Build install
run_if_release_test = make install
+It also combines on request with L<Dist::Zilla::Plugin::Alien>, you can set
+all parameter of the Alien plugin here, just by preceeding with I<alien_>, the
+only required parameter here is C<alien_repo>:
+
+ [@Author::GETTY]
+ alien_repo = http://myapp.org/releases
+ alien_bins = myapp myapp_helper
+ alien_name = myapp
+ alien_pattern_prefix = myapp-
+ alien_pattern_version = ([\d\.]+)
+ alien_pattern_suffix = \.tar\.gz
+ alien_pattern = myapp-([\d\.]+)\.tar\.gz
+
+=head1 ATTRIBUTES
+
+=head2 author
+
+This is used to name the L<CPAN|http://www.cpan.org/> author of the
+distribution. See L<Dist::Zilla::Plugin::Authority/authority>.
+
+=head2 release_branch
+
+This variable is used to set the release_branch, only releases on this branch
+will be allowed. See L<Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch/release_branch>.
+
+=head2 weaver_config
+
+This defines the L<PodWeaver> config that is used. See B<config_plugin> on
+L<Dist::Zilla::Plugin::PodWeaver>.
+
+=head2 no_cpan
+
+If set to 1, this attribute will disable L<Dist::Zilla::Plugin::UploadToCPAN>.
+By default a dzil release would release to L<CPAN|http://www.cpan.org/>.
+
+=head2 duckpan
+
+If set to 1, this attribute will activate L<Dist::Zilla::Plugin::UploadToDuckPAN>.
+With this way you upload your distribution to L<DuckPAN|http://duckpan.org>. So
+far only employee of L<DuckDuckGo|http://duckduckgo.com> can use this option.
+This attribute is NOT disabling the upload to CPAN. So if L</no_cpan> isn't
+set, the distribution will be uploaded to both. For more information about
+DuckPAN you can also go to the L<DuckDuckGo Community Platform|https://dukgo.com/>.
+
+=head2 no_install
+
+If set to 1, the resulting distribution can't be installed.
+
+=head2 no_makemaker
+
+
+=head2 no_installrelease
+
+By default, this bundle will install your distribution after the release. If
+you set this attribute to 1, then this will not happen. See
+L<Dist::Zilla::Plugin::InstallRelease>.
+
+If you use the L<Dist::Zilla::Plugin::Alien> options, then this one will not
+use L<Dist::Zilla::Plugin::InstallRelease>, instead, it will use the trick
+mentioned in L<Dist::Zilla::Plugin::Alien/InstallRelease>.
+
+=head2 installrelease_command
+
+If you don't like the usage of L<App::cpanminus> to install your distribution
+after install, you can set another command here. See B<install_command> on
+L<Dist::Zilla::Plugin::InstallRelease>.
+
+=head1 SEE ALSO
+
+L<Dist::Zilla::Plugin::Alien>
+
+L<Dist::Zilla::Plugin::Authority>
+
+L<Dist::Zilla::Plugin::BumpVersionFromGit>
+
+L<Dist::Zilla::PluginBundle::Git>
+
+L<Dist::Zilla::Plugin::ChangelogFromGit>
+
+L<Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch>
+
+L<Dist::Zilla::Plugin::GithubMeta>
+
+L<Dist::Zilla::Plugin::InstallRelease>
+
+L<Dist::Zilla::Plugin::MakeMaker::SkipInstall>
+
+L<Dist::Zilla::Plugin::PodWeaver>
+
+L<Dist::Zilla::Plugin::Repository>
+
+L<Dist::Zilla::Plugin::Run>
+
+L<Dist::Zilla::Plugin::TaskWeaver>
+
+L<Dist::Zilla::Plugin::UploadToDuckPAN>
+
=cut
use Dist::Zilla::PluginBundle::Basic;

0 comments on commit bc548ea

Please sign in to comment.