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

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