https://github.com/terrytangyuan/maintainer-tools

Collection of useful functions for project maintainers
https://github.com/terrytangyuan/maintainer-tools

github maintainer rstats

Last synced: about 1 month ago
JSON representation

Collection of useful functions for project maintainers

• Host: GitHub
• URL: https://github.com/terrytangyuan/maintainer-tools
• Owner: terrytangyuan
• License: other
• Created: 2020-05-19T20:56:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-01T01:48:26.000Z (about 4 years ago)
• Last Synced: 2024-06-05T02:31:47.934Z (4 months ago)
• Topics: github, maintainer, rstats
• Language: R
• Homepage:
• Size: 29.3 KB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - terrytangyuan/maintainer-tools - Collection of useful functions for project maintainers (R)

README

        
# maintainertools

**maintainertools** package provides a collection of useful functions for project maintainers, such as writing summaries on issues, pull requests, and preparing for releases for projects on GitHub.

## Installation

You can install the development version of **maintainertools** package from GitHub with:

```r

install.packages("remotes")

remotes::install_github("terrytangyuan/maintainer-tools")

```

## Example

This is a basic example which shows you how to generate a summary that can be included in release notes:

``` r

library(maintainertools)

repo <- "kubeflow/common"

from <- "2020-05-10"

until <- "2020-05-19"

labels_mapping <- list(

  "size/S" = "Small Changes",

  "size/L" = "Large Changes",

  "size/M" = "Medium Changes")

get_release_summary(repo, from, until, labels_mapping)

```

You can find an example release summmary [here](./tests/testthat/resources/example-release-notes.md).

Note that if you intend to run a large number of requests, you may want to add your GitHub token to environment variable like the following:

```r

Sys.setenv(GITHUB_TOKEN = "XXX")

```