git_remote_create: Create a New 'GitHub' Repository

In cjvanlissa/worcs: Workflow for Open Reproducible Code in Science

Create a New 'GitHub' Repository

Description

Given that a 'GitHub' user is configured, with the appropriate permissions, this function creates a new repository on your account.

Given that a 'GitHub' user is configured, with the appropriate permissions, this function pushes the current branch (if safe), then publishes a 'GitHub' Release of the repository indicated by repo to that user's account.

Usage

git_remote_create(name, private = TRUE)

git_release_publish(repo = ".", tag_name = NULL, release_name = NULL)

Arguments

name	Name of the repository to be created.
private	Whether or not the repository should be private, defaults to FALSE.
repo	The path to the 'Git' repository.
tag_name	Optional character string to specify the tag name. By default, this is set to NULL and git_release_publish() uses version numbers starting with ⁠0.1.0⁠ for both the tag_name and release_name arguments. Override this behavior, for example, to increment the major version number by specifying ⁠0.2.0⁠.
release_name	Optional character string to specify the tag name. By default, this is set to NULL and git_release_publish() uses version numbers starting with ⁠0.1.0⁠ for both the tag_name and release_name arguments. Override this behavior, for example, to increment the major version number by specifying ⁠0.2.0⁠.

Value

Invisibly returns a logical value, indicating whether the function was successful or not.

No return value. This function is called for its side effects.

Examples

git_remote_create()
## Not run: 
git_release_publish()

## End(Not run)

cjvanlissa/worcs documentation built on Jan. 18, 2025, 4:35 p.m.