{pr.helpers} (PR helpers package)

Lifecycle: experimental R-CMD-check Codecov test coverage CodeFactor CRAN status License: MIT

{pr.helpers} streamlines common pull request (GitHub) and merge request (GitLab) workflows from the command line in an R session.

Installation

You can install the development version of {pr.helpers} from GitHub with:

# install.packages("pak")
pak::pak("d-morrison/pr.helpers")

Example

This example builds a pull request URL for a feature branch:

library(pr.helpers)
pr_request_url(
  "https://github.com/acme/widgets.git",
  source_branch = "feature/new-report",
  target_branch = "main"
)
#> [1] "https://github.com/acme/widgets/compare/main...feature%2Fnew-report?expand=1"

Development

Building the Documentation Site

This package uses altdoc with Quarto to build its documentation site. To build and preview the documentation locally:

# Load the package
pkgload::load_all()

# Render the documentation
altdoc::render_docs()

# Preview the site
altdoc::preview_docs()

The documentation is automatically built and deployed to GitHub Pages via GitHub Actions when changes are pushed to the main branch.

Code of Conduct

Please note that the {pr.helpers} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.