compare_files: View file changes made between two commits
In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description Usage Arguments Details Value Examples

compare_files() summarises the file changes made between two commits in a table with the properties as columns and a row for each file. The base commit must be in the history of the head commit.

1	compare_files(base, head, repo, ...)

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

For more details see the GitHub API documentation:

https://docs.github.com/en/rest/reference/repos#compare-two-commits

compare_files() returns a tibble of file properties.

File Properties:

path: The path to the file within the repository.
sha: The SHA of the file blob.
status: Whether the file was "added", "modified" or "deleted".
additions: The number of lines added in the file.
deletions: The number of lines deleted in the file.
changes: The number of lines changed in the file.
patch: The git patch for the file.
html_url: The URL of the blob's web page in GitHub.

## Not run: 

  # View the files changes made between the current main branch and a release
  compare_files("main", "0.8.7", "ChadGoymer/githapi")


## End(Not run)