view release on metacpan or  search on metacpan

lib/CPAN/Maker.pm  view on Meta::CPAN

    resolver: scandeps
    requires: requires
    test-requires: test-requires
    required-modules: no
  path:
    recurse: yes
    pm-module: src/main/perl/lib
    tests: src/main/perl/t
    exe-files: src/main/perl/bin
  exclude-files: exclude_files
  extra: extra-files
  extra-files:
    - file
    - /usr/local/share/my-project:
      - file
  provides: provides
  postamble: postamble
  man-links:
  resources:
    homepage: 'http://github.com/rlauer6/perl-Amazon-API'
    bugtracker:
      web: 'http://github.com/rlauer6/perl-Amazon-API/issues'
      mailto: rlauer6@comcast.net
    repository:
      url: 'git://github.com/rlauer6/perl-Amazon-API.git'
      web: 'http://github.com/rlauer6/perl-Amazon-API'
      type: 'git'

The sections are described below:

=over 10

=item version

The version of of the specification format.  This should correspond
with the version of C<CPAN::Maker> that supports the format. It may be
used in future versions to validate the specification file.

=item project

=over 15

=item git

The path to a C<git> project. If this is included in the buildspec
then the bash script will clone that repo and use that repo as the
target of the build.  If the cloned repo includes a F<configure.ac>
file root directory the script will attempt to build the repo as a
autoconfiscated project.

 autoconf -i --force
 ./configure
 make

If F<configure.ac> is not found, the project will simply be cloned and
it will be assumed the Perl modules and artifacts to be packaged are
somewhere to be found in the project tree (as described in your
buildspec file). You should make sure that you set the C<path> section
accordingly so that the utility knows were to find your Perl modules.

I<I'm actually not sure how useful this feature is. I'm guessing that
the scenario for use might be if you have the buildspec file somewhere
other than the repo you wish to build or you don't own or don't want
to fork a project but want to build a CPAN distribution from it?>

=item description

The description of the module as it will be appear in the CPAN
repository.

=item author

The I<author> section should contain a name and email address.

=over 20

=item name

The author's name.

=item mailto

The author's email address.

=back

=back

=item pm-module

The name of the Perl module.

=item postamble

The name of a file that contains additional C<makefile> statements
that are appended to the F<Makefile> created by
F<Makefile.PL>. Typically, this will look something like:

 postamble ::

 install::
        # do something

=item man-links

Create symbolic links for executables to module man pages. Typically
used to create symlinks to modulinos. For example if C<Foo::Bar> is
implemented as a modulino and C<foo-bar> is the wrapper script, then
adding:

  man-links:
    - foo-bar: Foo::Bar

...would allow C<man foo-bar> to bring up the man page for C<Foo::Bar>.
The target module must contain POD - if no POD is found the link is
silently skipped.

=item include-version

If dependencies are resolved automatically, include the version
number. To disable this set this value to 'no'.