Retrieve information about GitHub Actions workflows and their runs.

Description

• action_workflows() - retrieve details on repo workflows.

• action_runs() - retrieve details on repo workflow runs.

• action_status() - DEPRECATED - retrieve details on most recent workflow runs.

• action_runtime() - retrieves runtime durations for workflow runs.

• action_artifacts() - retrieve details on available workflow artifacts.

• action_artifact_download() - downloads artifact(s) into a local directory.

• action_artifact_delete() - deletes artifact(s).

Usage

action_artifacts(repo, keep_expired = FALSE, which = c("latest", "all"))

action_artifact_delete(repo, ids)

action_artifact_download(
  repo,
  dir,
  ids = action_artifacts(repo),
  keep_zip = FALSE,
  file_pat = "",
  overwrite = FALSE
)

action_runs(
  repo,
  branch = NULL,
  event = NULL,
  status = NULL,
  created = NULL,
  limit = 1
)

action_status(
  repo,
  branch = NULL,
  event = NULL,
  status = NULL,
  created = NULL,
  limit = 1
)

action_runtime(
  repo,
  branch = NULL,
  event = NULL,
  status = NULL,
  created = NULL,
  limit = 1
)

action_workflows(repo, full = FALSE)

Arguments

Value

action_workflows(), action_runs(), action_runtime(), and action_artifacts all return tibbles containing information on requested repos' available workflows, recent workflow runs, workflow runs runtimes, and generated artifacts respectively.

action_artifact_download() returns a character vector containing the paths of all downloaded fules

action_artifact_delete() returns an invisible data frame containing repository names and ids of the deleted artifacts.

Examples

## Not run: 
action_workflows("rundel/ghclass")

action_runs("rundel/ghclass")

action_runtime(c("rundel/ghclass", "rundel/parsermd"))

action_artifacts(c("rundel/ghclass", "rundel/parsermd"))

## End(Not run)

Add or remove GitHub Actions badges from a repository

Description

• action_add_badge() - Add a GitHub Actions badge to a file.

• action_remove_badge() - Remove one or more GitHub Action badges from a file.

Usage

action_add_badge(
  repo,
  workflow = NULL,
  where = "^.",
  line_padding = "\n\n\n",
  file = "README.md"
)

action_remove_badge(repo, workflow_pat = ".*?", file = "README.md")

Arguments

Value

Both action_add_badge() and action_remove_badge() invisibly return a list containing the results of the relevant GitHub API call.

Create and delete branches in a repository

Description

• branch_create() - creates a new branch from an existing GitHub repo.

• branch_delete() - deletes a branch from an existing GitHub repo.

• branch_remove() - previous name of branch_delete, deprecated.

Usage

branch_create(repo, branch, new_branch)

branch_delete(repo, branch)

branch_remove(repo, branch)

Arguments

Value

branch_create()and branch_remove() invisibly return a list containing the results of the relevant GitHub API call.

See Also

repo_branches

Examples

## Not run: 
repo_create("ghclass-test", "test_branch", auto_init=TRUE)

branch_create("ghclass-test/test_branch", branch = "main", new_branch = "test")
repo_branches("ghclass-test/test_branch")

branch_delete("ghclass-test/test_branch", branch="test")
repo_branches("ghclass-test/test_branch")

repo_delete("ghclass-test/test_branch", prompt = FALSE)

## End(Not run)

Tools for limiting gh's GitHub api requests.

Description

• github_get_api_limit() - returns the current limit on results returned by gh.

• github_set_api_limit() - sets a limit on results returned by gh.

Usage

github_get_api_limit()

github_set_api_limit(limit = 10000L)

Arguments

Details

This value is stored in the "ghclass.api.limit" option globally.

Value

github_get_api_limit() returns a single integer value.

github_set_api_limit() invisibily returns the value of the limit argument.

Examples

github_get_api_limit()

github_set_api_limit(500)

github_get_api_limit()

Collect details on the authenticated user's GitHub organization memberships (based on the current PAT).

Description

Collect details on the authenticated user's GitHub organization memberships (based on the current PAT).

Usage

github_orgs(quiet = FALSE)

Arguments

Value

Returns a tibble with organization details.

Examples

## Not run: 
github_orgs()

## End(Not run)

Tools for handling GitHub personal access tokens (PAT)

Description

• github_get_token - returns the user's GitHub personal access token (PAT).

• github_set_token - defines the user's GitHub PAT by setting the GITHUB_PAT environmental variable. This value will persist until the session ends or gihub_reset_token() is called.

• github_reset_token - removes the value stored in the GITHUB_PAT environmental variable.

• github_test_token - checks if a PAT is valid by attempting to authenticate with the GitHub API.

• github_token_scopes - returns a vector of scopes granted to the token.

Usage

github_rate_limit()

github_graphql_rate_limit()

github_get_token()

github_set_token(token)

github_reset_token()

github_test_token(token = github_get_token())

github_token_scopes(token = github_get_token())

Arguments

Details

This package looks for the personal access token (PAT) in the following places (in order):

• Value of GITHUB_PAT environmental variable.

• Any GitHub PAT token(s) stored with gitcreds via gitcreds_set().

For additional details on creating a GitHub PAT see the usethis vignette on Managing Git(Hub) Credentials. For those who do not wish to read the entire article, the quick start method is to use:

• usethis::create_github_token() - to create the token and then,

• gitcreds::gitcreds_set() - to securely cache the token.

Value

github_get_token() returns the current PAT as a character string with the gh_pat class. See gh::gh_token() for additional details.

github_set_token() and github_reset_token() return the result of Sys.setenv() and Sys.unsetenv() respectively.

github_test_token() invisibly returns a logical value, TRUE if the test passes, FALSE if not.

github_token_scopes() returns a character vector of granted scopes.

Examples

## Not run: 
github_test_token()

github_token_scopes()

(pat = github_get_token())

github_set_token("ghp_BadTokenBadTokenBadTokenBadTokenBadToken")
github_get_token()
github_test_token()

github_set_token(pat)

## End(Not run)

Returns the login of the authenticated user (based on the current PAT).

Description

Returns the login of the authenticated user (based on the current PAT).

Usage

github_whoami(quiet = FALSE)

Arguments

Value

Character value containing user login.

Examples

## Not run: 
github_whoami()

## End(Not run)

withr-like functions for temporary personal access token

Description

Temporarily change the GITHUB_PAT environmental variable for GitHub authentication. Based on the withr interface.

Usage

with_pat(new, code)

local_pat(new, .local_envir = parent.frame())

Arguments

Details

if new = NA is used the GITHUB_PAT environment variable will be unset.

Value

The results of the evaluation of the code argument.

Examples

## Not run: 
with_pat("1234", print(github_get_token()))

## End(Not run)

GitHub Issue related tools

Description

• issue_create creates a new issue.

• issue_close closes an existing issue.

• issue_edit edits the properties of an existing issue.

Usage

issue_close(repo, number)

issue_create(
  repo,
  title,
  body,
  labels = character(),
  assignees = character(),
  delay = 0
)

issue_edit(
  repo,
  number,
  title = NULL,
  body = NULL,
  state = NULL,
  milestone = NULL,
  labels = list(),
  assignees = list()
)

Arguments

Value

All functions invisibly return a list containing the results of the relevant GitHub API call.

See Also

repo_issues

Examples

## Not run: 
repo_create("ghclass-test","test_issue")

issue_create(
  "ghclass-test/test_issue",
  title = "Issue 1",
  body = "This is an issue"
 )

issue_create(
  "ghclass-test/test_issue",
  title = "Issue 2", body = "This is also issue",
  label = "Important"
)

issue_create(
  "ghclass-test/test_issue",
  title = "Issue 3", body = "This is also issue",
  label = c("Important", "Super Important"),
  assignees = "rundel"
)

issue_close("ghclass-test/test_issue", 1)

issue_edit(
  "ghclass-test/test_issue", 2,
  title = "New issue 2 title!",
  body = "Replacement body text"
)

ghclass::repo_issues("ghclass-test/test_issue")

repo_delete("ghclass-test/test_issue", prompt=FALSE)

## End(Not run)

Functions for managing local git repositories

Description

• local_repo_clone() - Clones a GitHub repository to a local directory.

• local_repo_add() - Equivalent to ⁠git add⁠ - stages a file in a local repository.

• local_repo_commit() - Equivalent to ⁠git commit⁠ - commits staged files in a local repository.

• local_repo_push() - Equivalent to ⁠git push⁠ - push a local repository.

• local_repo_pull() - Equivalent to ⁠git pull⁠ - pull a local repository.

• local_repo_branch() - Equivalent to ⁠git branch⁠ - create a branch in a local repository.

• local_repo_log() - Equivalent to ⁠git log⁠ - returns a data frame for git log entries.

Usage

local_repo_add(repo_dir, files = ".")

local_repo_branch(repo_dir, branch)

local_repo_clone(
  repo,
  local_path = ".",
  branch = NULL,
  mirror = FALSE,
  verbose = FALSE
)

local_repo_commit(repo_dir, message)

local_repo_log(repo_dir, max = 100)

local_repo_pull(repo_dir, verbose = FALSE)

local_repo_push(
  repo_dir,
  remote = "origin",
  branch = NULL,
  force = FALSE,
  prompt = TRUE,
  mirror = FALSE,
  verbose = FALSE
)

Arguments

Details

All ⁠local_repo_*⁠ functions depend on the gert library being installed.

Value

local_repo_clone() invisibly returns a character vector of paths for the local repo directories.

local_repo_log() returns a tibble containing repository details.'

All other functions invisibly return a list containing the results of the relevant call to gert.

Examples

## Not run: 
repo = repo_create("ghclass-test", "local_repo_test")

dir = file.path(tempdir(), "repos")
local_repo = local_repo_clone(repo, dir)

local_repo_log(dir)

# Make a local change and push
writeLines("Hello World", file.path(local_repo, "hello.txt"))

local_repo_add(local_repo, "hello.txt")

local_repo_commit(local_repo, "Added hello world")

local_repo_push(local_repo)

repo_commits(repo)

# Pulling remote changes
repo_modify_file(repo, "hello.txt", pattern = ".*",  content = "!!!", method = "after")

local_repo_pull(local_repo)

local_repo_log(dir)

repo_delete("ghclass-test/local_repo_test", prompt=FALSE)

## End(Not run)

Rename local directories using a vector of patterns and replacements.

Description

This function is meant to help with renaming local student repos to include something more useful like ⁠Last, First name⁠ or a unique identifier for the purposes of ordering repository folders.

Usage

local_repo_rename(repo_dir, pattern, replacement)

Arguments

Value

Returns a character vector of the new repo directory paths, or NA if the rename failed.

Create a team or individual assignment

Description

This is a higher level function that combines the following steps:

• Create repos

• Create teams and invite students if necessary

• Add teams or individuals to the repositories

• Mirror a template repository to assignment repositories

Usage

org_create_assignment(
  org,
  repo,
  user,
  team = NULL,
  source_repo = NULL,
  private = TRUE,
  add_badges = FALSE
)

Arguments

Value

An invisible list containing the results of each step.

Obtain details on an organization's repos and teams

Description

• org_exists() - returns TRUE if the organization(s) exist on GitHub and FALSE otherwise.

• org_teams() - returns a (filtered) vector of organization teams.

• org_team_details() - returns a data frame of all organization teams containing identification and permission details.

• org_repos() - returns a (filtered) vector of organization repositories.

• org_repo_search() - search for repositories within an organization (preferred for large organizations).

• org_repo_stats() - returns a tibble of repositories belonging to a GitHub organization along with some basic statistics about those repositories.

Usage

org_exists(org)

org_repo_search(org, name, extra = "", full_repo = TRUE)

org_repo_stats(
  org,
  branch = NULL,
  filter = "",
  filter_type = "in:name",
  inc_commits = TRUE,
  inc_issues = TRUE,
  inc_prs = TRUE
)

org_repos(
  org,
  filter = NULL,
  exclude = FALSE,
  full_repo = TRUE,
  sort = c("full_name", "created", "updated", "pushed"),
  direction = c("asc", "desc"),
  type = c("all", "public", "private", "forks", "sources", "member", "internal")
)

org_team_details(org)

org_teams(org, filter = NULL, exclude = FALSE, team_type = c("name", "slug"))

Arguments

Value

org_exists() returns a logical vector.

org_teams(), org_repos, and org_repo_search() return a character vector of team or repo names.

org_team_details() and org_repo_stats() return tibbles.

Examples

## Not run: 
# Org repos and teams
org_repos("ghclass-test")

org_repos("ghclass-test", filter = "hw1-")

org_teams("ghclass-test")

org_team_details("ghclass-test")

## End(Not run)

Tools for managing organization membership

Description

• org_invite() - invites user(s) to a GitHub organization.

• org_remove() - remove user(s) from an organization (and all teams within that organization).

• org_members() - returns a (filtered) vector of organization members.

• org_pending() - returns a (filtered) vector of pending organization members.

• org_admins() - returns a vector of repository administrators. In the case of a non-organization owner (e.g. a user account) returns the owner's login.

Usage

org_admins(org)

org_invite(org, user)

org_members(org, filter = NULL, exclude = FALSE, include_admins = TRUE)

org_pending(org, filter = NULL, exclude = FALSE)

org_remove(org, user, prompt = TRUE)

Arguments

Value

org_members(), org_pending(), and org_admins all return a character vector of GitHub account names.

org_invite() and org_remove() invisibly return a list containing the results of the relevant GitHub API calls.

Examples

## Not run: 
# Org Details
org_admins("ghclass-test")

org_admins("rundel") # User, not an organization


# Org Membership - Invite, Status, and Remove
students = c("ghclass-anya", "ghclass-bruno", "ghclass-celine",
             "ghclass-diego", "ghclass-elijah","ghclass-francis")

org_invite("ghclass-test", students)

org_members("ghclass-test")

org_pending("ghclass-test")

org_remove("ghclass-test", students, prompt = FALSE)

org_pending("ghclass-test")

## End(Not run)

Organization permissions

Description

• org_sitrep() - Provides a situation report on a GitHub organization.

• org_set_repo_permission() - Change the default permission level for org repositories.

org_workflow_permissions() - Obtain the current default workflow permission value for the organization.

org_set_workflow_permissions() - Change the current default workflow permission value for the organization.

Usage

org_sitrep(org)

org_set_repo_permission(
  org,
  repo_permission = c("none", "read", "write", "admin")
)

org_workflow_permissions(org)

org_set_workflow_permissions(org, workflow_permission = c("read", "write"))

Arguments

Value

org_sitep() invisibly returns the org argument.

org_set_repo_permission() invisibly return a the result of the relevant GitHub API call.

org_workflow_permissions() returns a character vector with value of either "read" or "write".

org_set_workflow_permissions() invisibly return a the result of the relevant GitHub API call.

Examples

## Not run: 
org_sitrep("ghclass-test")

org_set_repo_permission("ghclass-test", "read")

org_workflow_permissions("ghclass-test")

org_set_workflow_permissions("ghclass-test", "write")

org_sitrep("ghclass-test")

# Cleanup
org_set_repo_permission("ghclass-test", "none")
org_set_workflow_permissions("ghclass-test", "read")

## End(Not run)

Retrieve information about GitHub Pages sites and builds.

Description

• pages_enabled() - returns TRUE if a Pages site exists for the repo.

• pages_status() - returns more detailed information about a repo's Pages site.

• pages_create() - creates a Pages site for the provided repos.

• pages_delete() - deletes the Pages site for the provided repos.

Usage

pages_enabled(repo)

pages_status(repo)

pages_create(
  repo,
  build_type = c("legacy", "workflow"),
  branch = "main",
  path = "/docs"
)

pages_delete(repo)

Arguments

Value

pages_enabled() returns a named logical vector - TRUE if a Pages site exists, FALSE otherwise.

pages_status() returns a tibble containing details on Pages sites.

pages_create() & pages_delete() return an invisible list containing the API responses.

Examples

## Not run: 
pages_enabled("rundel/ghclass")

pages_status("rundel/ghclass")

## End(Not run)

GitHub Pull Request related tools

Description

• pr_create() - create a pull request GitHub from the base branch to the head branch.

Usage

pr_create(repo, title, head, base, body = "", draft = FALSE)

Arguments

Value

pr_create() invisibly return a list containing the results of the relevant GitHub API calls.

See Also

repo_issues

Examples

## Not run: 
repo_create("ghclass-test", "test_pr", auto_init=TRUE)

branch_create("ghclass-test/test_pr", branch = "main", new_branch = "test")

repo_modify_file("ghclass-test/test_pr", "README.md", pattern = "test_pr",
                 content = "Hello", method = "after", branch = "test")

pr_create("ghclass-test/test_pr", title = "merge", head = "test", base = "main")

repo_delete("ghclass-test/test_pr", prompt = FALSE)

## End(Not run)

GitHub Repository tools - core functions

Description

• repo_create() - create a GitHub repository.

• repo_delete() - delete a GitHub repository.

• repo_rename() - rename a repository, note that renamed repositories retain their unique identifier and can still be accessed via their old names due to GitHub re-directing.

• repo_exists() - returns TRUE if the GitHub repository exists. It will also print a message if a repository has been renamed, unless quiet = TRUE.

• repo_mirror() - mirror the content of a repository to another repository, the target repo must already exist.

• repo_mirror_template() - mirror the content of a source template repository to a new repository, the target repo must not already exist.

• repo_is_template() - returns TRUE if a repository is a template repo.

• repo_set_template() - change the template status of a repository.

Usage

repo_create(
  org,
  name,
  prefix = "",
  suffix = "",
  private = TRUE,
  auto_init = FALSE,
  gitignore_template = "R"
)

repo_delete(repo, prompt = TRUE)

repo_exists(repo, strict = FALSE, quiet = FALSE)

repo_is_template(repo)

repo_mirror(
  source_repo,
  target_repo,
  overwrite = FALSE,
  verbose = FALSE,
  warn = TRUE
)

repo_mirror_template(source_repo, target_repo, private = TRUE)

repo_rename(repo, new_repo)

repo_set_template(repo, status = TRUE)

Arguments

Value

repo_create() returns a character vector of created repos (in owner/repo format)

repo_exists() and repo_is_template() both return a logical vector.

All other functions invisibly return a list containing the results of the relevant GitHub API calls.

Examples

## Not run: 
repo_create("ghclass-test", "repo_test")

repo_exists("ghclass-test/repo_test")

repo_rename("ghclass-test/repo_test", "repo_test_new")


# The new repo exists
repo_exists("ghclass-test/repo_test_new")

# The old repo forwards to the new repo
repo_exists("ghclass-test/repo_test")


# Check for the redirect by setting `strict = TRUE`
repo_exists("ghclass-test/repo_test", strict = TRUE)


# The prefered way of copying a repo is by making the source a template
repo_is_template("ghclass-test/repo_test_new")

repo_set_template("ghclass-test/repo_test_new")

repo_is_template("ghclass-test/repo_test_new")


# Given a template repo we can then directly copy the repo on GitHub
repo_mirror_template("ghclass-test/repo_test_new", "ghclass-test/repo_test_copy")

repo_exists("ghclass-test/repo_test_copy")

# Cleanup
repo_delete(
 c("ghclass-test/repo_test_new",
   "ghclass-test/repo_test_copy"),
 prompt = FALSE
)


## End(Not run)

GitHub Repository tools - repository details

Description

• repo_clone_url() - Returns the url, for cloning, a GitHub repo (either ssh or https)

• repo_branches() - Returns a (filtered) vector of branch names.

• repo_commits() - Returns a tibble of commits to a GitHub repository.

• repo_issues() - Returns a tibble of issues for a GitHub repository.

• repo_n_commits() - Returns a tibble of the number of commits in a GitHub repository (and branch).

• repo_prs() - Returns a tibble of pull requests for a GitHub repository.

• repo_pushes() - Returns a tibble of push activity to a GitHub repository.

Usage

repo_branches(repo)

repo_clone_url(repo, type = c("https", "ssh"))

repo_commits(
  repo,
  branch = NULL,
  sha = branch,
  path = NULL,
  author = NULL,
  since = NULL,
  until = NULL,
  quiet = FALSE
)

repo_issues(
  repo,
  state = c("open", "closed", "all"),
  assignee = NULL,
  creator = NULL,
  mentioned = NULL,
  labels = NULL,
  sort = c("created", "updated", "comments"),
  direction = c("desc", "asc"),
  since = NULL
)

repo_n_commits(repo, quiet = FALSE)

repo_prs(repo, state = c("open", "closed", "all"))

repo_pushes(
  repo,
  branch = NULL,
  author = NULL,
  time_period = c("all time", "day", "week", "month", "quarter", "year"),
  quiet = FALSE
)

Arguments

Value

repo_clone_url() and repo_branches() both return a character vector.

repo_commits(), repo_issues(), repo_n_commits(), and repo_prs() all return a tibble.

Examples

## Not run: 
repo_clone_url("rundel/ghclass")

repo_branches("rundel/ghclass")

repo_commits("rundel/ghclass")

repo_issues("rundel/ghclass")

repo_n_commits("rundel/ghclass", branch = "master")

repo_prs("rundel/ghclass")

## End(Not run)

GitHub Repository tools - file functions

Description

• repo_add_file() - Add / update files in a GitHub repository. Note that due to delays in caching, files that have been added very recently might not yet be displayed as existing and might accidentally be overwritten.

• repo_delete_file() - Delete a file from a GitHub repository

• repo_modify_file() - Modify an existing file within a GitHub repository.

• repo_ls() - Low level function for listing the files in a GitHub Repository

• repo_put_file() - Low level function for adding a file to a GitHub repository

• repo_get_file() - Low level function for retrieving the content of a file from a GitHub Repository

• repo_get_readme() - Low level function for retrieving the content of the README.md of a GitHub Repository

Usage

repo_add_file(
  repo,
  file,
  message = NULL,
  repo_folder = NULL,
  branch = NULL,
  preserve_path = FALSE,
  overwrite = FALSE
)

repo_delete_file(repo, path, message = NULL, branch = NULL)

repo_get_file(repo, path, branch = NULL, quiet = FALSE, include_details = TRUE)

repo_get_readme(repo, branch = NULL, include_details = TRUE)

repo_ls(repo, path = ".", branch = NULL, full_path = FALSE)

repo_modify_file(
  repo,
  path,
  pattern,
  content,
  method = c("replace", "before", "after"),
  all = FALSE,
  message = "Modified content",
  branch = NULL
)

repo_put_file(
  repo,
  path,
  content,
  message = NULL,
  branch = NULL,
  verbose = TRUE
)

Arguments

Examples

## Not run: 
repo = repo_create("ghclass-test", "repo_file_test", auto_init=TRUE)

repo_ls(repo, path = ".")

repo_get_readme(repo, include_details = FALSE)

repo_get_file(repo, ".gitignore", include_details = FALSE)

repo_modify_file(
  repo, path = "README.md", pattern = "repo_file_test",
  content = "\n\nHello world!\n", method = "after"
)

repo_get_readme(repo, include_details = FALSE)

repo_add_file(repo, file = system.file("DESCRIPTION", package="ghclass"))

repo_get_file(repo, "DESCRIPTION", include_details = FALSE)

repo_delete_file(repo, "DESCRIPTION")

repo_delete(repo, prompt=FALSE)

## End(Not run)

GitHub Repository tools - notification functions

Description

• repo_ignore() - Ignore a GitHub repository.

• repo_unwatch() - Unwatch / unsubscribe from a GitHub repository.

• repo_watch() - Watch / subscribe to a GitHub repository.

• repo_watching() - Returns a vector of your watched repositories. This should match the list at github.com/watching.

Usage

repo_unwatch(repo)

repo_watch(repo)

repo_ignore(repo)

repo_watching(filter = NULL, exclude = FALSE)

Arguments

Value

repo_ignore(), repo_unwatch(), and repo_watch() all invisibly return a list containing the results of the relevant GitHub API call.

repo_watching() returns a character vector of watched repos.

Examples

## Not run: 
repo_ignore("Sta323-Sp19/hw1")

repo_unwatch("rundel/ghclass")

repo_watch("rundel/ghclass")

## End(Not run)

Style repository with styler

Description

• repo_style implements "non-invasive pretty-printing of R source code" of .R or .Rmd files within a repository using the styler package and adhering to tidyverse formatting guidelines.

Usage

repo_style(
  repo,
  files = c("*.R", "*.Rmd"),
  branch = "styler",
  base,
  create_pull_request = TRUE,
  draft = TRUE,
  tag_collaborators = TRUE,
  prompt = TRUE
)

Arguments

Value

The functions returns NULL invisibly.

GitHub Repository tools - user functions

Description

• repo_add_user() - Add a user to a repository

• repo_remove_user() - Remove a user from a repository

• repo_add_team() - Add a team to a repository

• repo_remove_team() - Remove a team from a repository

• repo_user_permission() - Change a collaborator's permissions for a repository

• repo_team_permission() - Change a team's permissions for a repository

• repo_collaborators() - Returns a data frame of repos, their collaborators, and their permissions.

• repo_contributors() - Returns a data frame containing details on repository contributor(s).

Usage

repo_add_team(
  repo,
  team,
  permission = c("push", "pull", "admin", "maintain", "triage"),
  team_type = c("name", "slug")
)

repo_team_permission(
  repo,
  team,
  permission = c("push", "pull", "admin", "maintain", "triage"),
  team_type = c("name", "slug")
)

repo_add_user(
  repo,
  user,
  permission = c("push", "pull", "admin", "maintain", "triage")
)

repo_user_permission(
  repo,
  user,
  permission = c("push", "pull", "admin", "maintain", "triage")
)

repo_collaborators(repo, include_admins = TRUE)

repo_contributors(repo)

repo_remove_team(repo, team, team_type = c("name", "slug"))

repo_remove_user(repo, user)

Arguments

Details

Permissions can be set to any of the following:

• "pull" - can pull, but not push to or administer this repository.

• "push" - can pull and push, but not administer this repository.

• "admin" - can pull, push and administer this repository.

• "maintain" - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.

• "triage" - Recommended for contributors who need to proactively manage issues and pull requests without write access.

Value

repo_collaborators() and repo_contributoes return a tibble.

All other functions invisibly return a list containing the results of the relevant GitHub API calls.

Examples

## Not run: 
repo = repo_create("ghclass-test", "hw1")

team_create("ghclass-test", "team_awesome")

repo_add_user(repo, "rundel")

repo_add_team(repo, "team_awesome")

repo_remove_team(repo, "team_awesome")

repo_collaborators(repo)

repo_contributors(repo)
repo_contributors("rundel/ghclass")

# Cleanup
repo_delete(repo, prompt=FALSE)

## End(Not run)

Create, delete, and rename teams within an organization

Description

• team_create() - create teams in a GitHub organization

• team_delete() - delete a team from a GitHub organization.

• team_rename() - rename an existing team

Usage

team_create(
  org,
  team,
  prefix = "",
  suffix = "",
  privacy = c("secret", "closed")
)

team_delete(org, team, team_type = c("name", "slug"), prompt = TRUE)

team_rename(org, team, new_team, team_type = c("name", "slug"))

Arguments

Value

All functions invisibly return a list containing the results of the relevant GitHub API calls.

Examples

## Not run: 
team_create("ghclass-test",c("hw1-team01","hw1-team02"))

org_teams("ghclass-test", "hw1-")

team_rename("ghclass-test", "hw1-team02", "hw1-team03")

org_teams("ghclass-test", "hw1-")

team_delete("ghclass-test", "hw1-team01", prompt = FALSE)

org_teams("ghclass-test", "hw1-")


# Cleanup
team_delete("ghclass-test", org_teams("ghclass-test", "hw1-"), prompt = FALSE)

## End(Not run)

Tools for inviting, removing, and managing members of an organization team

Description

• team_invite() - add members to team(s).

• team_remove() - remove members from team(s).

• team_members() - returns a tibble of team members.

• team_pending() - returns a tibble of pending team members.

• team_repos() - returns a tibble of teams and their repos.

Usage

team_invite(org, user, team, team_type = c("name", "slug"))

team_members(org, team = org_teams(org), team_type = c("name", "slug"))

team_pending(org, team = org_teams(org), team_type = c("name", "slug"))

team_remove(org, user, team, team_type = c("name", "slug"))

team_repos(org, team = org_teams(org), team_type = c("name", "slug"))

Arguments

Value

team_members(), team_pending(), and team_repos() all return a tibble.

team_invite() and team_remove() invisibly return a list containing the results of the relevant GitHub API calls.

Examples

## Not run: 
team_create("ghclass-test",c("hw1-team01","hw1-team02"))

team_invite("ghclass-test", user = "rundel", team = c("hw1-team01", "hw1-team02", "missing_team"))

team_remove("ghclass-test", user = "rundel", team = c("hw1-team01", "missing_team"))

team_members("ghclass-test", org_teams("ghclass-test", "hw1-"))

team_pending("ghclass-test", org_teams("ghclass-test", "hw1-"))

# Add team repo
repo_create("ghclass-test", name = "hw1-team02")
repo_add_team("ghclass-test/hw1-team02", team = "hw1-team02")

team_repos("ghclass-test", org_teams("ghclass-test", "hw1-"))


# Cleanup
repo_delete("ghclass-test/hw1-team02", prompt = FALSE)
team_delete("ghclass-test", org_teams("ghclass-test", "hw1-"), prompt = FALSE)

## End(Not run)

GitHub user related tools

Description

• user_exists() - returns TRUE if the username(s) (or organization) exist on GitHub and FALSE otherwise. Note that GitHub considers organizations to be a type of user.

• user_repos() - returns a (filtered) vector of repositories belonging to the user.

• user_type() - returns a vector of the accounts' types.

Usage

user_exists(user)

user_repos(
  user,
  type = c("owner", "all", "public", "private", "member"),
  filter = NULL,
  exclude = FALSE,
  full_repo = TRUE
)

user_type(user)

Arguments

Value

user_exists() returns a logical vector.

user_repos() and user_type() retrun a character vector.

Examples

## Not run: 
user_exists(c("rundel", "ghclass-test", "hopefullydoesnotexist"))

user_repos("rundel", type = "public", filter = "ghclass")

user_repos("ghclass-test")

org_repos("ghclass-test")

user_type(c("rundel", "ghclass-test"))

## End(Not run)