https://github.com/grinnz/dist-zilla-pluginbundle-starter-git

Dist::Zilla::PluginBundle::Starter::Git - A minimal Dist::Zilla plugin bundle for git workflows
https://github.com/grinnz/dist-zilla-pluginbundle-starter-git

Last synced: 5 days ago
JSON representation

Dist::Zilla::PluginBundle::Starter::Git - A minimal Dist::Zilla plugin bundle for git workflows

• Host: GitHub
• URL: https://github.com/grinnz/dist-zilla-pluginbundle-starter-git
• Owner: Grinnz
• License: other
• Created: 2018-09-25T03:19:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-10T03:01:57.000Z (almost 4 years ago)
• Last Synced: 2024-11-13T05:34:13.128Z (about 2 months ago)
• Language: Perl
• Homepage: https://metacpan.org/pod/Dist::Zilla::PluginBundle::Starter::Git
• Size: 54.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.pod
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
=pod

=head1 NAME

Dist::Zilla::PluginBundle::Starter::Git - A minimal Dist::Zilla plugin bundle for git workflows

=head1 SYNOPSIS

  ; dist.ini

  name    = My-Cool-Distribution

  author  = Example Jones 

  license = Perl_5

  copyright_holder = Example Jones

  copyright_year   = 2017

  version = 0.001

  

  [@Starter::Git]      ; all that is needed to start

  revision = 5         ; always defaults to revision 3

  

  ; configuring examples

  installer = ModuleBuildTiny

  -remove = Pod2Readme ; to use [Readme::Brief] instead, for example

  ExecDir.dir = script ; change the directory used by [ExecDir]

  managed_versions = 1 ; uses the main module version, and bumps module versions after release

  regenerate = LICENSE ; copy LICENSE to repository after release or dzil regenerate

=head1 DESCRIPTION

The C<[@Starter::Git]> plugin bundle for L is a subclass of the

L<[@Starter]|Dist::Zilla::PluginBundle::Starter> plugin bundle designed to

support a Git-based workflow.

In addition to the standard C<[@Starter]> behavior, this bundle restricts the

gathered files to those committed to the git repository, allowing F<.gitignore>

to also ignore files when assembling the distribution; and commits, tags, and

pushes after a successful release.

See the L guide and the base

L<[@Starter]|Dist::Zilla::PluginBundle::Starter> documentation for more

information, as this documentation only details the specifics of this subclass.

For one-line initialization of a new C<[@Starter::Git]>-based distribution, try

L.

=head1 OPTIONS

C<[@Starter::Git]> inherits the options from

L<[@Starter]|Dist::Zilla::PluginBundle::Starter>, and can similarly be further

configured by the composed roles, as in

L.

=head2 revision

  [@Starter::Git]

  revision = 5

As in L, but defaults to

revision 3. C<[@Starter::Git]> requires at least revision 3.

=head2 installer

As in L.

=head2 managed_versions

As in L, and

additionally uses L<[Git::Commit]|Dist::Zilla::Plugin::Git::Commit> a second

time after L<[BumpVersionAfterRelease]|Dist::Zilla::Plugin::BumpVersionAfterRelease>

to commit the bumped versions (with the plugin name C).

=head2 regenerate

As in L, and allows changes to

the copied files to be committed in the C.

=head1 REVISIONS

The C<[@Starter::Git]> plugin bundle supports the following revisions.

=head2 Revision 3

Revision 3 is the default and is equivalent to using the following plugins:

=over 2

=item L<[Git::GatherDir]|Dist::Zilla::Plugin::Git::GatherDir>

=item L<[MetaYAML]|Dist::Zilla::Plugin::MetaYAML>

=item L<[MetaJSON]|Dist::Zilla::Plugin::MetaJSON>

=item L<[License]|Dist::Zilla::Plugin::License>

=item L<[Pod2Readme]|Dist::Zilla::Plugin::Pod2Readme>

=item L<[PodSyntaxTests]|Dist::Zilla::Plugin::PodSyntaxTests>

=item L<[Test::ReportPrereqs]|Dist::Zilla::Plugin::Test::ReportPrereqs>

=item L<[Test::Compile]|Dist::Zilla::Plugin::Test::Compile>

  xt_mode = 1

=item L<[MakeMaker]|Dist::Zilla::Plugin::MakeMaker>

=item L<[Manifest]|Dist::Zilla::Plugin::Manifest>

=item L<[PruneCruft]|Dist::Zilla::Plugin::PruneCruft>

=item L<[ManifestSkip]|Dist::Zilla::Plugin::ManifestSkip>

=item L<[RunExtraTests]|Dist::Zilla::Plugin::RunExtraTests>

=item L<[Git::Check]|Dist::Zilla::Plugin::Git::Check>

  allow_dirty = dist.ini

  allow_dirty = Changes

=item L<[TestRelease]|Dist::Zilla::Plugin::TestRelease>

=item L<[ConfirmRelease]|Dist::Zilla::Plugin::ConfirmRelease>

=item L<[UploadToCPAN]|Dist::Zilla::Plugin::UploadToCPAN>

=item L<[Git::Commit E Release_Commit]|Dist::Zilla::Plugin::Git::Commit>

  allow_dirty = dist.ini

  allow_dirty = Changes

  add_files_in = /

  commit_msg = %v%n%n%c

=item L<[Git::Tag]|Dist::Zilla::Plugin::Git::Tag>

  tag_format = %v

  tag_message = %v

=item L<[Git::Push]|Dist::Zilla::Plugin::Git::Push>

=item L<[MetaConfig]|Dist::Zilla::Plugin::MetaConfig>

=item L<[MetaNoIndex]|Dist::Zilla::Plugin::MetaNoIndex>

  directory = t

  directory = xt

  directory = inc

  directory = share

  directory = eg

  directory = examples

=item L<[MetaProvides::Package]|Dist::Zilla::Plugin::MetaProvides::Package>

  inherit_version = 0

=item L<[ShareDir]|Dist::Zilla::Plugin::ShareDir>

=item L<[ExecDir]|Dist::Zilla::Plugin::ExecDir>

=back

This revision differs from L

as follows:

=over 2

=item *

Uses L<[Git::GatherDir]|Dist::Zilla::Plugin::Git::GatherDir>

instead of L<[GatherDir]|Dist::Zilla::Plugin::GatherDir>.

=item *

Includes the following additional plugins:

L<[Git::Check]|Dist::Zilla::Plugin::Git::Check>,

L<[Git::Commit]|Dist::Zilla::Plugin::Git::Commit>,

L<[Git::Tag]|Dist::Zilla::Plugin::Git::Tag>,

L<[Git::Push]|Dist::Zilla::Plugin::Git::Push>.

=back

=head2 Revision 4

Revision 4 has no specific differences beyond the changes in

L.

=head2 Revision 5

Revision 5 has no specific differences beyond the changes in

L.

=head1 BUGS

Report any issues on the public bugtracker.

=head1 AUTHOR

Dan Book 

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Dan Book.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=head1 SEE ALSO

L, L, L,

L

=cut