Dogcows Code - chaz/p5-Dist-Zilla-PluginBundle-Author-CCM/blob - README.md

   1 # NAME
   2
   3 Dist::Zilla::PluginBundle::Author::CCM - A plugin bundle for distributions built by CCM
   4
   5 # VERSION
   6
   7 version 0.009
   8
   9 # SYNOPSIS
  10
  11     # In your dist.ini file:
  12     [@Author::CCM]
  13
  14 # DESCRIPTION
  15
  16 You probably don't want to use this.
  17
  18     ; VERSION
  19     [Git::NextVersion]
  20
  21     ; GATHER
  22     [Git::GatherDir]
  23     exclude_filename    = LICENSE
  24     exclude_filename    = README.md
  25     [PruneCruft]
  26     [PruneFiles]
  27     filename            = dist.ini
  28
  29     [CopyFilesFromBuild]
  30     copy                = LICENSE
  31     [ExecDir]
  32
  33     ; PREREQS
  34     [AutoPrereqs]
  35     [Prereqs::FromCPANfile]     ; if a cpanfile exists in root
  36     [Prereqs::AuthorDeps]
  37
  38     ; TESTS
  39     [MetaTests]
  40     [Test::CPAN::Changes]
  41     [PodCoverageTests]
  42     [PodSyntaxTests]
  43     [Test::Pod::No404s]
  44     [Test::Compile]
  45     [Test::MinimumVersion]
  46     max_target_perl     = 5.10.1
  47     [Test::EOL]
  48     [Test::NoTabs]
  49     [Test::Perl::Critic]
  50     [Test::Portability]
  51     [Test::CleanNamespaces]
  52     [Test::ReportPrereqs]
  53
  54     ; METADATA
  55     [Authority]
  56     do_munging          = 0
  57     [MetaJSON]
  58     [MetaYAML]
  59     [MetaNoIndex]
  60     directory           = eg
  61     directory           = share
  62     directory           = shares
  63     directory           = t
  64     directory           = xt
  65     [MetaProvides::Package]
  66     [Keywords]
  67     [Git::Contributors]
  68     order_by            = commits
  69     [GithubMeta]
  70     issues              = 1
  71
  72     ; MUNGE
  73     [PodWeaver]
  74     config_plugin       = @Author::CCM
  75     [OverridePkgVersion]
  76
  77     ; GENERATE FILES
  78     [License]
  79     [ReadmeAnyFromPod]
  80     filename            = README.md
  81     locaton             = root
  82     type                = markdown
  83     phase               = release
  84     [ReadmeAnyFromPod]
  85     filename            = README
  86     location            = build
  87     type                = text
  88     [Manifest]
  89     [ManifestSkip]
  90
  91     [MakeMaker]                 ; override with the "installer" attribute
  92
  93     ; RELEASE
  94     [NextRelease]
  95     [CheckChangesHasContent]
  96     [Git::Check]
  97     [RunExtraTests]
  98     [TestRelease]
  99     [ConfirmRelease]
 100     [UploadToCPAN]              ; disable with the "no_upload" attribute
 101     [Git::Commit]
 102     commit_msg          = Release %N %v%t%n%n%c
 103     [Git::CommitBuild]
 104     branch              =
 105     release_branch      = dist
 106     release_message     = Version %v%t
 107     [Git::Tag]
 108     tag_message         = Version %v%t%n%n%c
 109     [Git::Push]
 110     push_to             = origin master +master:refs/heads/release +dist
 111     remotes_must_exist  = 0
 112
 113 # ATTRIBUTES
 114
 115 ## max\_target\_perl
 116
 117 Specify the minimum perl version. Defaults to `5.10.1`.
 118
 119 ## authority
 120
 121 Specify the release authority. Defaults to `cpan:CCM`.
 122
 123 ## installer
 124
 125 Specify which installer to use, such as:
 126
 127 - `MakeMaker` (default)
 128 - `MakeMaker::Custom`
 129
 130 ## airplane
 131
 132 Disable plugins that use the network, and prevent releasing.
 133
 134 ## no\_upload
 135
 136 Do not upload to CPAN or git push.
 137
 138 # METHODS
 139
 140 ## configure
 141
 142 Required by [Dist::Zilla::Role::PluginBundle::Easy](https://metacpan.org/pod/Dist::Zilla::Role::PluginBundle::Easy).
 143
 144 # SEE ALSO
 145
 146 - [Dist::Zilla](https://metacpan.org/pod/Dist::Zilla)
 147 - [Dist::Zilla::PluginBundle::Author::ETHER](https://metacpan.org/pod/Dist::Zilla::PluginBundle::Author::ETHER)
 148
 149 # BUGS
 150
 151 Please report any bugs or feature requests on the bugtracker website
 152 [https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues](https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues)
 153
 154 When submitting a bug or request, please include a test-file or a
 155 patch to an existing test-file that illustrates the bug or desired
 156 feature.
 157
 158 # AUTHOR
 159
 160 Charles McGarvey <chazmcgarvey@brokenzipper.com>
 161
 162 # COPYRIGHT AND LICENSE
 163
 164 This software is copyright (c) 2016 by Charles McGarvey.
 165
 166 This is free software; you can redistribute it and/or modify it under
 167 the same terms as the Perl 5 programming language system itself.