activitySince: What are the issues, pulls, commits created since a date?

In seandavi/BiocPkgTools: Collection of simple tools for learning about Bioconductor Packages

What are the issues, pulls, commits created since a date?

Description

This function uses the gh package to get a list of either issues, pull requests, or GitHub commits since the specified date for a particular GitHub repository. The repository must have both the username / organization and the name, e.g., "Bioconductor/S4Vectors".

Usage

activitySince(
  gh_repo,
  activity = c("issues", "pulls", "commits"),
  status = c("closed", "open", "all"),
  Date,
  issue_metadata = c("created_at", "number", "title"),
  token = NULL
)

Arguments

gh_repo	character(1) The GitHub repository location including the username / organization and the repository name, e.g., "Bioconductor/S4Vectors"
activity	character(1) The type of repository activity to pull from the GitHub API. It can be one of "issues" (default), "pulls", or "commits".
status	character(1) One of 'closed', 'open', or 'all' corresponding to the issue state desired from the GitHub API (Default: "closed"). This argument is ignored for the "commits" activity report.
Date	character(1) The date cutoff from which to analyze closed issues in the YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format (ISO 8601).
issue_metadata	character() The metadata labels to extract from the gh::gh response. See ?gh::gh for more details. Defaults to 'created_at', 'number', and 'title'. This argument is ignored for the "commits" activity report.
token	character(1) For big requests, e.g., commit history, you may be prompted to use a GitHub Personal Access Token. Enter the token as plain text.

Details

The tibble returned by the commits activity report contains five columns:

• 'committer_date'

• 'commit' - hash

• 'parents' - hash of parent for merge commits

• 'author'

• 'message'

For information on other columns, refer to the GitHub API under repository issues or pulls (e.g., ⁠/repos/:repo/issues⁠).

Value

A tibble with three columns corresponding to issue metadata (i.e., "created_at", "number", "title")

Examples

if (interactive()) {

  activitySince("Bioconductor/S4Vectors", "issues", "closed", "2021-05-01")
  activitySince("Bioconductor/S4Vectors", "issues", "open", "2022-05-01")
  activitySince("Bioconductor/S4Vectors", "commits", Date = "2022-05-01")

}

seandavi/BiocPkgTools documentation built on Feb. 2, 2024, 12:02 p.m.