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.003
   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::EOL]
  49     [Test::NoTabs]
  50     [Test::Perl::Critic]
  51     [Test::Portability]
  52     [Test::CleanNamespaces]
  53     [Test::ReportPrereqs]
  54
  55     ; METADATA
  56     [Authority]
  57     do_munging          = 0
  58     [MetaJSON]
  59     [MetaYAML]
  60     [MetaNoIndex]
  61     directory           = eg
  62     directory           = share
  63     directory           = shares
  64     directory           = t
  65     directory           = xt
  66     [MetaProvides::Package]
  67     [Keywords]
  68     [Git::Contributors]
  69     order_by            = commits
  70     [GithubMeta]
  71     issues              = 1
  72
  73     ; MUNGE
  74     [PodWeaver]
  75     config_plugin       = @Author::CCM
  76     [OverridePkgVersion]
  77
  78     ; GENERATE FILES
  79     [License]
  80     [ReadmeAnyFromPod]
  81     filename            = README.md
  82     locaton             = root
  83     type                = markdown
  84     phase               = release
  85     [ReadmeAnyFromPod]
  86     filename            = README
  87     location            = build
  88     type                = text
  89     [TravisYML]
  90     [Manifest]
  91     [ManifestSkip]
  92
  93     [MakeMaker]                 ; override with the "installer" attribute
  94
  95     ; RELEASE
  96     [CheckChangesHasContent]
  97     [Git::Check]
  98     [RunExtraTests]
  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 ## authority
 117
 118 Specify the release authority. Defaults to `cpan:CCM`.
 119
 120 ## installer
 121
 122 Specify which installer to use, such as:
 123
 124 - `MakeMaker` (default)
 125 - `MakeMaker::Custom`
 126
 127 ## airplane
 128
 129 Disable plugins that use the network, and prevent releasing.
 130
 131 ## no\_upload
 132
 133 Do not upload to CPAN or git push.
 134
 135 # METHODS
 136
 137 ## configure
 138
 139 Required by [Dist::Zilla::Role::PluginBundle::Easy](https://metacpan.org/pod/Dist::Zilla::Role::PluginBundle::Easy).
 140
 141 # SEE ALSO
 142
 143 - [Dist::Zilla](https://metacpan.org/pod/Dist::Zilla)
 144 - [Dist::Zilla::PluginBundle::Author::ETHER](https://metacpan.org/pod/Dist::Zilla::PluginBundle::Author::ETHER)
 145
 146 # BUGS
 147
 148 Please report any bugs or feature requests on the bugtracker website
 149 [https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues](https://github.com/chazmcgarvey/Dist-Zilla-PluginBundle-Author-CCM/issues)
 150
 151 When submitting a bug or request, please include a test-file or a
 152 patch to an existing test-file that illustrates the bug or desired
 153 feature.
 154
 155 # AUTHOR
 156
 157 Charles McGarvey <chazmcgarvey@brokenzipper.com>
 158
 159 # COPYRIGHT AND LICENSE
 160
 161 This software is copyright (c) 2016 by Charles McGarvey.
 162
 163 This is free software; you can redistribute it and/or modify it under
 164 the same terms as the Perl 5 programming language system itself.