| 1 | package Dist::Zilla::MintingProfile::Starter::Git; | ||
| 2 | |||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | with 'Dist::Zilla::Role::MintingProfile::ShareDir'; | |
| 5 | 1 | ▶ | use namespace::clean; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | |||
| 7 | 1 | our $VERSION = 'v6.0.0'; | |
| 8 | |||
| 9 | 1 | __PACKAGE__->meta->make_immutable; | |
| 10 | 1 | 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 | The L<Dist::Zilla::Starter> guide explains how the L<Dist::Zilla> plugin system | ||
| 35 | works, and how it is specifically used for the minting process. | ||
| 36 | |||
| 37 | =head1 CUSTOMIZING | ||
| 38 | |||
| 39 | It's easy to create your own local version of this (or any other) minting | ||
| 40 | profile which you can customize as you choose. First create a new directory in | ||
| 41 | C<profiles> in your dzil configuration folder: | ||
| 42 | |||
| 43 | $ mkdir -p ~/.dzil/profiles/myminter | ||
| 44 | |||
| 45 | Then, copy the contents from the profile you want (such as the | ||
| 46 | C<profiles/default> directory of this distribution). Modify the copied files to | ||
| 47 | your liking, and then you can use it to mint a distribution. | ||
| 48 | |||
| 49 | $ dzil new -p myminter My::New::Dist | ||
| 50 | |||
| 51 | You can also specify a default provider (C<-P> option) or profile (C<-p> | ||
| 52 | option) in your dzil config (C<~/.dzil/config.ini>). | ||
| 53 | |||
| 54 | ; config.ini | ||
| 55 | [%Mint] | ||
| 56 | profile = myminter | ||
| 57 | |||
| 58 | ; or | ||
| 59 | [%Mint] | ||
| 60 | provider = Starter::Git | ||
| 61 | |||
| 62 | $ dzil new My::New::Dist # now uses the specified provider and/or profile | ||
| 63 | |||
| 64 | If no provider or profile is configured or specified, C<dzil new> will use the | ||
| 65 | C<default> local profile, or the default C<[@Basic]> profile shipped with | ||
| 66 | L<Dist::Zilla>. | ||
| 67 | |||
| 68 | =head1 BUGS | ||
| 69 | |||
| 70 | Report any issues on the public bugtracker. | ||
| 71 | |||
| 72 | =head1 AUTHOR | ||
| 73 | |||
| 74 | Dan Book <dbook@cpan.org> | ||
| 75 | |||
| 76 | =head1 COPYRIGHT AND LICENSE | ||
| 77 | |||
| 78 | This software is Copyright (c) 2018 by Dan Book. | ||
| 79 | |||
| 80 | This is free software, licensed under: | ||
| 81 | |||
| 82 | The Artistic License 2.0 (GPL Compatible) | ||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | L<Dist::Zilla>, L<Dist::Zilla::PluginBundle::Starter::Git>, | ||
| 87 | L<Dist::Zilla::MintingProfile::Starter> | ||