https://github.com/mdelapenya/probot-paths-labeller

A GitHub App built with Probot (https://github.com/probot/probot) that adds labels in Pull Requests based on contents of the "paths-labeller.yml" file
https://github.com/mdelapenya/probot-paths-labeller

labels probot

Last synced: about 1 month ago
JSON representation

A GitHub App built with Probot (https://github.com/probot/probot) that adds labels in Pull Requests based on contents of the "paths-labeller.yml" file

• Host: GitHub
• URL: https://github.com/mdelapenya/probot-paths-labeller
• Owner: mdelapenya
• License: other
• Created: 2019-12-18T09:19:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T15:57:16.000Z (over 1 year ago)
• Last Synced: 2024-11-14T17:06:49.595Z (2 months ago)
• Topics: labels, probot
• Language: JavaScript
• Homepage:
• Size: 704 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Probot: Paths labeller

> a GitHub App built with [Probot](https://github.com/probot/probot) that adds labels in Pull Requests based on contents of the `paths-labeller.yml` file. It will use base-ref's configuration when calculating the labels to add.

>

> This probot will add the labels declared in the descriptor if the pull request is not a draft pull request.

## Usage

1. Create a `paths-labeller.yml` file in your repository, under the `.github` directory.

1. Use your own labels as the keys in the YAML file.

1. Use an array for paths to be added to a label. Pathname Format: glob

1. Use the empty label (`- "":`) for exclusions. Paths here won't receive a label unless precedent labels apply.

1. Wait for new Pull Requests to be opened or synchronised.

An example `paths-labeller.yml` file is shown here:

```yaml

---

- "label1":

  - "*"

- "label2":

  - "*"

- "":

  - "*.pdf"

  - "*.md"

  - "LICENSE"

  - "PRIVATE.doc"

- "label4":

  - "*.py"

  - "*.rb"

- "label5":

  - "*.py"

  - "*.rb"

- "label6":

  - "folder/**/*.txt"

  - "*.doc"

- "label8":

  - "script.py"

```