Package org.kohsuke.github

Class GHCreateRepositoryBuilder

java.lang.Object

org.kohsuke.github.GHCreateRepositoryBuilder

public class GHCreateRepositoryBuilder
extends Object

Creates a repository

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected org.kohsuke.github.Requester	requester
protected boolean	updateInPlace

Constructor Summary

Constructors

Constructor	Description
GHCreateRepositoryBuilder(String name, GitHub root, String apiTail)

Method Summary

Modifier and Type	Method	Description
S	allowMergeCommit(boolean enabled)	Allow or disallow merging pull requests with a merge commit.
S	allowRebaseMerge(boolean enabled)	Allow or disallow rebase-merging pull requests.
S	allowSquashMerge(boolean enabled)	Allow or disallow squash-merging pull requests.
GHCreateRepositoryBuilder	autoInit(boolean enabled)	If true, create an initial commit with empty README.
protected S	continueOrDone()	Chooses whether to return a continuing builder or an updated data record If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done().
GHRepository	create()	Creates a repository with all the parameters.
S	defaultBranch(String branch)	Default repository branch
S	deleteBranchOnMerge(boolean enabled)	After pull requests are merged, you can have head branches deleted automatically.
S	description(String description)	Description for repository
GHRepository	done()	Finishes an update, committing changes.
S	downloads(boolean enabled)	Enables downloads
GHCreateRepositoryBuilder	fromTemplateRepository(String templateOwner, String templateRepo)	Create repository from template repository
GHCreateRepositoryBuilder	gitignoreTemplate(String language)	Creates a default .gitignore
S	homepage(String homepage)	Homepage for repository
S	homepage(URL homepage)	Homepage for repository
S	issues(boolean enabled)	Enables issue tracker
S	isTemplate(boolean enabled)	Specifies whether the repository is a template.
GHCreateRepositoryBuilder	licenseTemplate(String license)	Desired license template to apply
GHCreateRepositoryBuilder	owner(String owner)	Specifies the ownership of the repository.
S	private_(boolean enabled)	Sets the repository to private
S	projects(boolean enabled)	Enables projects
GHCreateRepositoryBuilder	team(GHTeam team)	The team that gets granted access to this repository.
GHCreateRepositoryBuilder	templateRepository(boolean enabled)	Deprecated. Use isTemplate(boolean) method instead
S	visibility(GHRepository.Visibility visibility)	Sets the repository visibility
S	wiki(boolean enabled)	Enables wiki
protected S	with(String name, Object value)	Applies a value to a name for this builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

requester

@Nonnull
protected final org.kohsuke.github.Requester requester

updateInPlace

protected boolean updateInPlace

Constructor Detail

GHCreateRepositoryBuilder

public GHCreateRepositoryBuilder(String name,
                                 GitHub root,
                                 String apiTail)

Method Detail

gitignoreTemplate

public GHCreateRepositoryBuilder gitignoreTemplate(String language)
                                            throws IOException

Creates a default .gitignore

Parameters:

language - template to base the ignore file on

Returns:

a builder to continue with building See https://developer.github.com/v3/repos/#create

Throws:

IOException - In case of any networking error or error from the server.

licenseTemplate

public GHCreateRepositoryBuilder licenseTemplate(String license)
                                          throws IOException

Desired license template to apply

Parameters:

license - template to base the license file on

Returns:

a builder to continue with building See https://developer.github.com/v3/repos/#create

Throws:

IOException - In case of any networking error or error from the server.

autoInit

public GHCreateRepositoryBuilder autoInit(boolean enabled)
                                   throws IOException

If true, create an initial commit with empty README.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

team

public GHCreateRepositoryBuilder team(GHTeam team)
                               throws IOException

The team that gets granted access to this repository. Only valid for creating a repository in an organization.

Parameters:

team - team to grant access to

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

templateRepository

@Deprecated
public GHCreateRepositoryBuilder templateRepository(boolean enabled)
                                             throws IOException

Deprecated.

Use isTemplate(boolean) method instead

Specifies whether the repository is a template.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

owner

public GHCreateRepositoryBuilder owner(String owner)
                                throws IOException

Specifies the ownership of the repository.

Parameters:

owner - organization or personage

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

fromTemplateRepository

@Preview(BAPTISTE)
public GHCreateRepositoryBuilder fromTemplateRepository(String templateOwner,
                                                        String templateRepo)

Create repository from template repository

Parameters:

templateOwner - template repository owner

templateRepo - template repository

Returns:

a builder to continue with building

See Also:

GitHub API Previews

create

public GHRepository create()
                    throws IOException

Creates a repository with all the parameters.

Returns:

the gh repository

Throws:

IOException - if repository cannot be created

allowSquashMerge

public S allowSquashMerge(boolean enabled)
                   throws IOException

Allow or disallow squash-merging pull requests.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

allowMergeCommit

public S allowMergeCommit(boolean enabled)
                   throws IOException

Allow or disallow merging pull requests with a merge commit.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

allowRebaseMerge

public S allowRebaseMerge(boolean enabled)
                   throws IOException

Allow or disallow rebase-merging pull requests.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

deleteBranchOnMerge

public S deleteBranchOnMerge(boolean enabled)
                      throws IOException

After pull requests are merged, you can have head branches deleted automatically.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

defaultBranch

public S defaultBranch(String branch)
                throws IOException

Default repository branch

Parameters:

branch - branch name

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

description

public S description(String description)
              throws IOException

Description for repository

Parameters:

description - description of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

homepage

public S homepage(URL homepage)
           throws IOException

Homepage for repository

Parameters:

homepage - homepage of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

homepage

public S homepage(String homepage)
           throws IOException

Homepage for repository

Parameters:

homepage - homepage of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

private_

public S private_(boolean enabled)
           throws IOException

Sets the repository to private

Parameters:

enabled - private if true

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

visibility

public S visibility(GHRepository.Visibility visibility)
             throws IOException

Sets the repository visibility

Parameters:

visibility - visibility of repository

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

issues

public S issues(boolean enabled)
         throws IOException

Enables issue tracker

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

projects

public S projects(boolean enabled)
           throws IOException

Enables projects

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

wiki

public S wiki(boolean enabled)
       throws IOException

Enables wiki

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

downloads

public S downloads(boolean enabled)
            throws IOException

Enables downloads

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

isTemplate

@Preview(BAPTISTE)
public S isTemplate(boolean enabled)
             throws IOException

Specifies whether the repository is a template.

Parameters:

enabled - true if enabled

Returns:

a builder to continue with building

Throws:

IOException - In case of any networking error or error from the server.

done

public GHRepository done()
                  throws IOException

Finishes an update, committing changes. This method may update-in-place or not. Either way it returns the resulting instance.

Returns:

an instance with updated current data

Throws:

IOException - if there is an I/O Exception

with

@Nonnull
@BetaApi
protected S with(@Nonnull
                 String name,
                 Object value)
          throws IOException

Applies a value to a name for this builder. If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done(). If AbstractBuilder is not the same as AbstractBuilder, this method will return an AbstractBuilder and letting the caller batch together multiple changes and call done() when they are ready.

Parameters:

name - the name of the field

value - the value of the field

Returns:

either a continuing builder or an updated data record

Throws:

IOException - if an I/O error occurs

continueOrDone

@Nonnull
@BetaApi
protected S continueOrDone()
                    throws IOException

Chooses whether to return a continuing builder or an updated data record If AbstractBuilder is the same as AbstractBuilder, this method will commit changes after the first value change and return a AbstractBuilder from done(). If AbstractBuilder is not the same as AbstractBuilder, this method will return an AbstractBuilder and letting the caller batch together multiple changes and call done() when they are ready.

Returns:

either a continuing builder or an updated data record

Throws:

IOException - if an I/O error occurs