pr: Git PR Utilities

In gitr: A Lightweight API for 'Git'

Git PR Utilities

Description

Git PR Utilities

Usage

get_pr_msgs(branch = NULL)

get_pr_sha(branch = NULL)

Arguments

branch

character(1). The name of a branch, typically a feature branch.

Value

get_pr_msgs(): see get_commit_msgs().

get_pr_sha(): character vector of SHAs corresponding to the PR (relative to the default branch).

Functions

• get_pr_msgs(): gets the commit messages for the current branch relative to the ⁠origin/{main,master}⁠ branch in the remote. Typically these "new" commits that would be merged as part of a PR to ⁠origin/{main,master}⁠.

• get_pr_sha(): gets the commit SHA-1 a branch (by default current) relative to the default branch in the remote, usually either origin/main or origin/master. See git_default_br(). If there are un-pushed commit on the current default branch, it returns them.

Examples

## Not run: 
  # SHAs from feature branch differ from default br
  get_pr_sha()

  # commit messages from the SHAs above
  # for a PR `branch` -> `remotes/origin/{main,master}`
  get_pr_msgs()

  # for a feature branch -> default branch
  get_pr_msgs("feature")

## End(Not run)

gitr documentation built on April 13, 2025, 1:08 a.m.