https://github.com/rstudio/issuetriager

R package and GitHub workflow action for triaging issues
https://github.com/rstudio/issuetriager

actions

Last synced: 5 days ago
JSON representation

R package and GitHub workflow action for triaging issues

• Host: GitHub
• URL: https://github.com/rstudio/issuetriager
• Owner: rstudio
• License: other
• Created: 2022-10-08T00:19:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-08T04:34:37.000Z (about 2 years ago)
• Last Synced: 2024-05-09T11:59:20.294Z (6 months ago)
• Topics: actions
• Language: R
• Homepage: https://rstudio.github.io/issuetriager/
• Size: 363 KB
• Stars: 1
• Watchers: 17
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# issuetriager GitHub Action

![package test](https://github.com/rstudio/issuetriager/actions/workflows/check-standard.yml/badge.svg)

![package test](https://github.com/rstudio/issuetriager/actions/workflows/render-rmarkdown.yml/badge.svg)

The goal of issuetriager is to streamline the triage process for projects that

have frequent issues reported on GitHub. Normal use is inside of a GitHub workflow

that is triggered to run when issues are opened, analyze the text, and use the

results for automatic labeling, closing, or notification about issues.

This action indicates whether the phrase was found within the text or not.

## Inputs

## `check-phrase`

**Required** The phrase to search for in the issue body. Default `"I'm stuck because of this issue.: True"`.

## `issue-body`

**Required** The text body that you want to search for the phrase. Default `"${{ github.event.issue.body }}"`.

## Outputs

## `contains-phrase`

Whether the check phrase was found

## Example usage

```

on:

  issues:

    types: [opened]

jobs:

  triage:

    runs-on: ubuntu-latest

    name: A job to triage issues

    steps:

      - name: check the text

        id: triage

        uses: rstudio/issuetriager@v1

        with:

          check-phrase: 'this is a blocking issue'

          issue-body: ${{ github.event.issue.body }}

      # Use the output from the `triage` step

      - name: Label the issue as blocking

        run: echo "The time was ${{ steps.hello.outputs.time }}"

        if: ${{ steps.triage.outputs.contains-phrase }}

        uses: andymckay/labeler@master

        with:

          add-labels: "blocking"

```

## Development

Clone this repo from GitHub, and open the project in RStudio IDE.

```

# CTRL-SHIFT-L to load the package

# SHIFT-CMD-T to run tests

```

## Code of Conduct

Please note that the issuetriager project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.