Dist::Zilla::Plugin::GitHub::Create - Create a new GitHub repo on dzil new
version 0.40
Configure git with your GitHub credentials:
$ git config --global github.user LoginName $ git config --global github.password GitHubPassword
Alternatively you can install Config::Identity and write your credentials in the (optionally GPG-encrypted) ~/.github file as follows:
~/.github
login LoginName password GitHubpassword
(if only the login name is set, the password will be asked interactively)
then, in your profile.ini:
# default config [GitHub::Create] # to override publicness [GitHub::Create] public = 0 # use a template for the repository name [GitHub::Create] repo = {{ lc $dist -> name }}
See "ATTRIBUTES" for more options.
This Dist::Zilla plugin creates a new git repository on GitHub.com when a new distribution is created with dzil new.
dzil new
It will also add a new git remote pointing to the newly created GitHub repository's private URL. See "ADDING REMOTE" for more info.
repo
Specifies the name of the GitHub repository to be created (by default the name of the dist is used). This can be a template, so something like the following will work:
repo = {{ lc $dist -> name }}
org
Specifies the name of a GitHub organization in which to create the repository (by default the repository is created in the user's account).
prompt
Prompt for confirmation before creating a GitHub repository if this option is set to true (default is false).
public
Create a public repository if this option is set to true (default), otherwise create a private repository.
remote
Specifies the git remote name to be added (default 'origin'). This will point to the newly created GitHub repository's private URL. See "ADDING REMOTE" for more info.
has_issues
Enable issues for the new repository if this option is set to true (default).
has_wiki
Enable the wiki for the new repository if this option is set to true (default).
has_downloads
Enable downloads for the new repository if this option is set to true (default).
prompt_2fa
Prompt for GitHub two-factor authentication code if this option is set to true (default is false). If this option is set to false but GitHub requires 2fa for the login, it'll be automatically enabled.
By default GitHub::Create adds a new git remote pointing to the newly created GitHub repository's private URL if, and only if, a git repository has already been initialized, and if the remote doesn't already exist in that repository.
GitHub::Create
To take full advantage of this feature you should use, along with GitHub::Create, the Dist::Zilla::Plugin::Git::Init plugin, leaving blank its remote option, as follows:
[Git::Init] ; here goes your Git::Init config, remember ; to not set the 'remote' option [GitHub::Create]
You may set your preferred remote name, by setting the remote option of the GitHub::Create plugin, as follows:
[Git::Init] [GitHub::Create] remote = myremote
Remember to put [Git::Init] before [GitHub::Create].
[Git::Init]
[GitHub::Create]
After the new remote is added, the current branch will track it, unless remote tracking for the branch was already set. This may allow one to use the Dist::Zilla::Plugin::Git::Push plugin without the need to do a git push between the dzil new and dzil release. Note though that this will work only when the push.default Git configuration option is set to either upstream or simple (which will be the default in Git 2.0). If you are using an older Git or don't want to change your config, you may want to have a look at Dist::Zilla::Plugin::Git::PushInitial.
git push
dzil release
push.default
upstream
simple
Alessandro Ghedini <alexbio@cpan.org>
Copyright 2011 Alessandro Ghedini.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Dist::Zilla::Plugin::GitHub, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::GitHub
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::GitHub
For more information on module installation, please visit the detailed CPAN module installation guide.