File Coverage

blib/lib/Dist/Zilla/MintingProfile/Starter/Git.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Dist::Zilla::MintingProfile::Starter::Git;
2              
3 1     1   3175101 use Moose;
  1         3  
  1         8  
4             with 'Dist::Zilla::Role::MintingProfile::ShareDir';
5 1     1   6712 use namespace::clean;
  1         3  
  1         8  
6              
7             our $VERSION = 'v4.0.0';
8              
9             __PACKAGE__->meta->make_immutable;
10             1;
11              
12             =head1 NAME
13              
14             Dist::Zilla::MintingProfile::Starter::Git - A minimal Dist::Zilla minting profile for git workflows
15              
16             =head1 SYNOPSIS
17              
18             # setup only needs to be run once to set up your dzil config
19             $ dzil setup
20             $ dzil new -P Starter::Git My::New::Dist
21              
22             =head1 DESCRIPTION
23              
24             This minting profile for L<< C<dzil new>|Dist::Zilla::App::Command::new >>
25             creates a minimal new distribution consisting of a basic C<dist.ini> using the
26             L<[@Starter::Git]|Dist::Zilla::PluginBundle::Starter::Git> plugin bundle, a
27             skeleton for the main module and its documentation, and a basic F<.gitignore>.
28             The author, license, and copyright will be populated in the C<dist.ini> and
29             documentation from the current dzil C<config.ini>, which can be initialized
30             using L<< C<dzil setup>|Dist::Zilla::App::Command::setup >>. The version is
31             initialized statically as C<0.001>. The directory is then initialized as a
32             git repository using L<[Git::Init]|Dist::Zilla::Plugin::Git::Init>.
33              
34             =head1 CUSTOMIZING
35              
36             It's easy to create your own local version of this (or any other) minting
37             profile which you can customize as you choose. First create a new directory in
38             C<profiles> in your dzil configuration folder:
39              
40             $ mkdir -p ~/.dzil/profiles/myminter
41              
42             Then, copy the contents from the profile you want (such as the
43             C<profiles/default> directory of this distribution). Modify the copied files to
44             your liking, and then you can use it to mint a distribution.
45              
46             $ dzil new -p myminter My::New::Dist
47              
48             You can also specify a default provider (C<-P> option) or profile (C<-p>
49             option) in your dzil config (C<~/.dzil/config.ini>).
50              
51             ; config.ini
52             [%Mint]
53             profile = myminter
54              
55             ; or
56             [%Mint]
57             provider = Starter::Git
58              
59             $ dzil new My::New::Dist # now uses the specified provider and/or profile
60              
61             If no provider or profile is configured or specified, C<dzil new> will use the
62             C<default> local profile, or the default C<[@Basic]> profile shipped with
63             L<Dist::Zilla>.
64              
65             =head1 BUGS
66              
67             Report any issues on the public bugtracker.
68              
69             =head1 AUTHOR
70              
71             Dan Book <dbook@cpan.org>
72              
73             =head1 COPYRIGHT AND LICENSE
74              
75             This software is Copyright (c) 2018 by Dan Book.
76              
77             This is free software, licensed under:
78              
79             The Artistic License 2.0 (GPL Compatible)
80              
81             =head1 SEE ALSO
82              
83             L<Dist::Zilla>, L<Dist::Zilla::PluginBundle::Starter::Git>,
84             L<Dist::Zilla::MintingProfile::Starter>