view_sha: View the SHA for a commit

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function returns the commit SHA given a git reference. A reference can be either a SHA, branch or tag. If it is a branch then the head commit is used.

Usage

view_sha(ref, repo, ...)

Arguments

ref	(string) Either a SHA, branch or tag used to identify the commit.
repo	(string) The repository specified in the format: owner/repo.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/repos#get-a-commit

Value

view_sha() returns the commit SHA as a string.

Examples

## Not run: 

  view_sha("a-tag", repo = "ChadGoymer/githapi")
  view_sha("a-branch", repo = "ChadGoymer/githapi")


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.