git_upload: Upload module to code-sharing service
In AntonelliLab/outsider.devtools: Build 'outsider' Modules

git_upload

R Documentation

Upload module to code-sharing service

Description

Upload module to a git-based code-sharing service. Initiate a git repo, add core module files, commit and push to remote.

Usage

git_upload(flpth, username, service = c("github", "gitlab", "bitbucket"))

Arguments

`flpth`	File path to module.
`username`	Username for code-sharing service.
`service`	Code-sharing service

Details

Remote URL is determined to be: code sharing URL + username + R package name. Git must be configured on a user's system before this function can be run.

Value

Logical

Examples

# Git must be configured before function can be run.
# To configure, provide your name and email via the command-line, e.g.
# git config --global user.name "John Doe"
# git config --global user.email johndoe@example.com
# To check your username and email, try:
# git config --list

# NOT RUN
# # construct a simple module
# module_path <- module_skeleton(program_name = 'echo', flpth = getwd())
# module_check(flpth = module_path)
# module_identities(flpth = module_path)
# # after these steps all files are built, to upload to git use:
# git_upload(flpth = module_path, username = '[YOUR USERNAME]',
#            service = '[SERVICE]')

AntonelliLab/outsider.devtools documentation built on June 20, 2022, 4:36 a.m.