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.001
   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     [ExecDir]
  25     [ExtraTests]
  26
  27     ; GATHER
  28     [Git::GatherDir]
  29     exclude_filename    = LICENSE
  30     exclude_filename    = README.md
  31     [PruneCruft]
  32     [PruneFiles]
  33     filename            = dist.ini
  34
  35     [CopyFilesFromBuild]
  36     copy                = LICENSE
  37
  38     ; PREREQS
  39     [AutoPrereqs]
  40     [Prereqs::FromCPANfile]     ; if a cpanfile exists in root
  41     [Prereqs::AuthorDeps]
  42
  43     ; TESTS
  44     [MetaTests]
  45     [Test::CPAN::Changes]
  46     [PodCoverageTests]
  47     [PodSyntaxTests]
  48     [Test::Pod::No404s]
  49     [Test::Compile]
  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     [ReadmeAnyFromPod]
  87     filename            = README
  88     location            = build
  89     type                = text
  90     [TravisYML]
  91     [Manifest]
  92     [ManifestSkip]
  93
  94     [MakeMaker]                 ; override with the "installer" attribute
  95
  96     ; RELEASE
  97     [CheckChangesHasContent]
  98     [Git::Check]
  99     [TestRelease]
 100     [ConfirmRelease]
 101     [UploadToCPAN]              ; disable with the "no_upload" attribute
 102     [Git::Commit]
 103     commit_msg          = Release %N %v%t%n%n%c
 104     [Git::CommitBuild]
 105     branch              =
 106     release_branch      = dist
 107     release_message     = Version %v%t
 108     [Git::Tag]
 109     tag_message         = Version %v%t%n%n%c
 110     [Git::Push]
 111     push_to             = origin master +master:refs/heads/release +dist
 112     remotes_must_exist  = 0
 113
 114 # ATTRIBUTES
 115
 116 ## installer
 117
 118 Specify which installer to use, such as:
 119
 120 - `MakeMaker` (default)
 121 - `MakeMaker::Custom`
 122
 123 ## airplane
 124
 125 Disable plugins that use the network, and prevent releasing.
 126
 127 ## no\_upload
 128
 129 Do not upload to CPAN.
 130
 131 # METHODS
 132
 133 ## configure
 134
 135 Required by [Dist::Zilla::Role::PluginBundle::Easy](https://metacpan.org/pod/Dist::Zilla::Role::PluginBundle::Easy).
 136
 137 # SEE ALSO
 138
 139 - [Dist::Zilla](https://metacpan.org/pod/Dist::Zilla)
 140 - [Dist::Zilla::PluginBundle::Author::ETHER](https://metacpan.org/pod/Dist::Zilla::PluginBundle::Author::ETHER)
 141
 142 # BUGS
 143
 144 Please report any bugs or feature requests on the bugtracker website
 145 [https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues](https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues)
 146
 147 When submitting a bug or request, please include a test-file or a
 148 patch to an existing test-file that illustrates the bug or desired
 149 feature.
 150
 151 # AUTHOR
 152
 153 Charles McGarvey <chazmcgarvey@brokenzipper.com>
 154
 155 # COPYRIGHT AND LICENSE
 156
 157 This software is copyright (c) 2016 by Charles McGarvey.
 158
 159 This is free software; you can redistribute it and/or modify it under
 160 the same terms as the Perl 5 programming language system itself.