1Dist::Zilla::Plugin::GiUts:e:rInCiotn(t3r)ibuted Perl DoDciusmte:n:tZaitliloan::Plugin::Git::Init(3)
2
6 Dist::Zilla::Plugin::Git::Init - Initialize git repository on dzil new
7
9 version 2.048
10
12 In your profile.ini:
13 [Git::Init]
15 commit_message = initial commit ; this is the default
16 commit = 1 ; this is the default
17 branch = ; this is the default (means master)
18 remote = origin https://github.com/USERNAME/%N.git ; no default
19 push_url = origin git@github.com:USERNAME/%{lc}N.git ; no default
20 config = user.email USERID@cpan.org ; there is no default
21
23 This plugin initializes a git repository when a new distribution is
24 created with "dzil new".
25 Plugin options
27 The plugin accepts the following options:
28 • commit_message - the commit message to use when checking in the
30 newly-minted dist. Defaults to "initial commit".
31 • commit - if true (the default), commit the newly-minted dist. If
33 set to a false value, add the files to the Git index but don't
34 actually make a commit.
35 • branch - the branch name under which the newly-minted dist is
37 checked in (if "commit" is true). Defaults to an empty string,
38 which means that the Git default branch is used (master).
39 • config - a config setting to make in the repository. No config
41 entries are made by default. A setting is specified as "OPTION
42 VALUE". This may be specified multiple times to add multiple
43 entries.
44 • remote - a remote to add to the repository. No remotes are added
46 by default. A remote is specified as "NAME URL". This may be
47 specified multiple times to add multiple remotes.
48 • push_url - the URL to use to push to a particular remote to add to
50 the repository. No URLs are added by default. A remote is
51 specified as "NAME URL". This may be specified multiple times to
52 specify push URLs for multiple remotes, and is not required if the
53 URL is the same as the one already set for that remote.
54 Per the documentation for git-remote(1): Note that the push_url and
56 the corresponding URL specified with "remote", even though they can
57 be set differently, must still refer to the same place. What you
58 pushed to the push URL should be what you would see if you
59 immediately fetched from the fetch URL (the URL specified with
60 "remote".) If you are trying to fetch from one place (e.g. your
61 upstream) and push to another (e.g. your publishing repository),
62 use two separate remotes.
63 This, therefore, is best used in cases where pushing requires
65 authentication, but pulling does not, or if pulling is via git or
66 ssh, but pushing is via https, on the same repository.
67 Formatting options
69 You can use the following codes in "commit_message", "config",
70 "remote", or "push_url":
71 %n A newline.
73 %N The distribution name. You can also use "%{lc}N" or "%{uc}N" to
75 get the name in lower case or upper case, respectively.
76
78 Bugs may be submitted through the RT bug tracker
79 <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-
80 Git> (or bug-Dist-Zilla-Plugin-Git@rt.cpan.org <mailto:bug-Dist-Zilla-
81 Plugin-Git@rt.cpan.org>).
82 There is also a mailing list available for users of this distribution,
84 at <http://dzil.org/#mailing-list>.
85 There is also an irc channel available for users of this distribution,
87 at "#distzilla" on "irc.perl.org" <irc://irc.perl.org/#distzilla>.
88
90 Jerome Quelin
91
93 This software is copyright (c) 2009 by Jerome Quelin.
94 This is free software; you can redistribute it and/or modify it under
96 the same terms as the Perl 5 programming language system itself.
97perl v5.34.0 2022-01-21 Dist::Zilla::Plugin::Git::Init(3)