1Dist::Zilla::Plugin::UpUlsoeardTCooCnPtArNi(b3u)ted PerlDiDsotc:u:mZeinltlaat:i:oPnlugin::UploadToCPAN(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::UploadToCPAN - upload the dist to CPAN
7

VERSION

9       version 6.031
10

SYNOPSIS

12       If loaded, this plugin will allow the release command to upload to the
13       CPAN.
14

DESCRIPTION

16       This plugin looks for configuration in your "dist.ini" or (more likely)
17       "~/.dzil/config.ini":
18
19         [%PAUSE]
20         username = YOUR-PAUSE-ID
21         password = YOUR-PAUSE-PASSWORD
22
23       If this configuration does not exist, it can read the configuration
24       from "~/.pause", in the same format that cpan-upload requires:
25
26         user YOUR-PAUSE-ID
27         password YOUR-PAUSE-PASSWORD
28
29       If neither configuration exists, it will prompt you to enter your
30       username and password during the BeforeRelease phase.  Entering a blank
31       username or password will abort the release.
32
33       You can't put your password in your dist.ini.  C'mon now!
34

PERL VERSION

36       This module should work on any version of perl still receiving updates
37       from the Perl 5 Porters.  This means it should work on any version of
38       perl released in the last two to three years.  (That is, if the most
39       recently released version is v5.40, then this module should work on
40       both v5.40 and v5.38.)
41
42       Although it may work on older versions of perl, no guarantee is made
43       that the minimum required version will not be increased.  The version
44       may be increased for any reason, and there is no promise that patches
45       will be accepted to lower the minimum required perl.
46

ATTRIBUTES

48   credentials_stash
49       This attribute holds the name of a PAUSE stash that will contain the
50       credentials to be used for the upload.  By default, UploadToCPAN will
51       look for a %PAUSE stash.
52
53   username
54       This option supplies the user's PAUSE username.  It will be looked for
55       in the user's PAUSE configuration; if not found, the user will be
56       prompted.
57
58   password
59       This option supplies the user's PAUSE password.  It cannot be provided
60       via dist.ini.  It will be looked for in the user's PAUSE configuration;
61       if not found, the user will be prompted.
62
63   pause_cfg_file
64       This is the name of the file containing your pause credentials.  It
65       defaults .pause.  If you give a relative path, it is taken to be
66       relative to "pause_cfg_dir".
67
68   pause_cfg_dir
69       This is the directory for resolving a relative "pause_cfg_file".  it
70       defaults to the glob expansion of ~.
71
72   pause_cfg
73       This is a hashref of defaults loaded from ~/.pause -- this attribute is
74       subject to removal in future versions, as the config-loading behavior
75       in CPAN::Uploader is improved.
76
77   subdir
78       If given, this specifies a subdirectory under the user's home directory
79       to which to upload.  Using this option is not recommended.
80
81   upload_uri
82       If given, this specifies an alternate URI for the PAUSE upload form.
83       By default, the default supplied by CPAN::Uploader is used.  Using this
84       option is not recommended in most cases.
85
86   retries
87       The number of retries to perform on upload failure (5xx response). The
88       default is set to 3 by this plugin. This option will be passed to
89       CPAN::Uploader.
90
91   retry_delay
92       The number of seconds to wait between retries. The default is set to 5
93       seconds by this plugin. This option will be passed to CPAN::Uploader.
94

AUTHOR

96       Ricardo SIGNES 😏 <cpan@semiotic.systems>
97

99       This software is copyright (c) 2023 by Ricardo SIGNES.
100
101       This is free software; you can redistribute it and/or modify it under
102       the same terms as the Perl 5 programming language system itself.
103
104
105
106perl v5.36.1                      2023-11-2D1ist::Zilla::Plugin::UploadToCPAN(3)
Impressum