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.005
   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     [NextRelease]
  21     [ReversionOnRelease]
  22     prompt              = 1
  23
  24     ; GATHER
  25     [Git::GatherDir]
  26     exclude_filename    = LICENSE
  27     exclude_filename    = README.md
  28     [PruneCruft]
  29     [PruneFiles]
  30     filename            = dist.ini
  31
  32     [CopyFilesFromBuild]
  33     copy                = LICENSE
  34     [ExecDir]
  35
  36     ; PREREQS
  37     [AutoPrereqs]
  38     [Prereqs::FromCPANfile]     ; if a cpanfile exists in root
  39     [Prereqs::AuthorDeps]
  40
  41     ; TESTS
  42     [MetaTests]
  43     [Test::CPAN::Changes]
  44     [PodCoverageTests]
  45     [PodSyntaxTests]
  46     [Test::Pod::No404s]
  47     [Test::Compile]
  48     [Test::MinimumVersion]
  49     max_target_perl     = 5.10.1
  50     [Test::EOL]
  51     [Test::NoTabs]
  52     [Test::Perl::Critic]
  53     [Test::Portability]
  54     [Test::CleanNamespaces]
  55     [Test::ReportPrereqs]
  56
  57     ; METADATA
  58     [Authority]
  59     do_munging          = 0
  60     [MetaJSON]
  61     [MetaYAML]
  62     [MetaNoIndex]
  63     directory           = eg
  64     directory           = share
  65     directory           = shares
  66     directory           = t
  67     directory           = xt
  68     [MetaProvides::Package]
  69     [Keywords]
  70     [Git::Contributors]
  71     order_by            = commits
  72     [GithubMeta]
  73     issues              = 1
  74
  75     ; MUNGE
  76     [PodWeaver]
  77     config_plugin       = @Author::CCM
  78     [OverridePkgVersion]
  79
  80     ; GENERATE FILES
  81     [License]
  82     [ReadmeAnyFromPod]
  83     filename            = README.md
  84     locaton             = root
  85     type                = markdown
  86     phase               = release
  87     [ReadmeAnyFromPod]
  88     filename            = README
  89     location            = build
  90     type                = text
  91     [TravisYML]
  92     build_branch        = /^(dist|build\/.*)$/
  93     [Manifest]
  94     [ManifestSkip]
  95
  96     [MakeMaker]                 ; override with the "installer" attribute
  97
  98     ; RELEASE
  99     [CheckChangesHasContent]
 100     [Git::Check]
 101     [RunExtraTests]
 102     [TestRelease]
 103     [ConfirmRelease]
 104     [UploadToCPAN]              ; disable with the "no_upload" attribute
 105     [Git::Commit]
 106     commit_msg          = Release %N %v%t%n%n%c
 107     [Git::CommitBuild]
 108     branch              =
 109     release_branch      = dist
 110     release_message     = Version %v%t
 111     [Git::Tag]
 112     tag_message         = Version %v%t%n%n%c
 113     [Git::Push]
 114     push_to             = origin master +master:refs/heads/release +dist
 115     remotes_must_exist  = 0
 116
 117 # ATTRIBUTES
 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.