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: |
... |
Parameters passed to |
For more details see the GitHub API documentation:
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.
1 2 3 4 5 6 7 | ## 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)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.