https://github.com/JulienKode/team-labeler-action

⚡️ Github action to label your pull requests based on the author name ⚡️
https://github.com/JulienKode/team-labeler-action

actions github github-actions javascript labeler-action pull-request teams typescript workflow

Last synced: 3 months ago
JSON representation

⚡️ Github action to label your pull requests based on the author name ⚡️

• Host: GitHub
• URL: https://github.com/JulienKode/team-labeler-action
• Owner: JulienKode
• License: apache-2.0
• Created: 2019-12-29T15:24:39.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-06T14:42:22.000Z (4 months ago)
• Last Synced: 2024-10-26T06:52:00.853Z (3 months ago)
• Topics: actions, github, github-actions, javascript, labeler-action, pull-request, teams, typescript, workflow
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/team-labeler-action
• Size: 53.1 MB
• Stars: 49
• Watchers: 3
• Forks: 43
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Add Label to your Pull Requests based on the author team name
• fucking-awesome-actions - Add Label to your Pull Requests based on the author team name
• awesome-workflows - Add Label to your Pull Requests based on the author team name

README

        
# Team Labeler Action 👥

[![build](https://github.com/JulienKode/team-labeler-action/workflows/build/badge.svg)](https://github.com/JulienKode/team-labeler-action/actions)

[![test](https://github.com/JulienKode/team-labeler-action/workflows/test/badge.svg)](https://github.com/JulienKode/team-labeler-action/actions)

[![GitHub issues](https://img.shields.io/github/issues/JulienKode/team-labeler-action?style=flat-square)](https://github.com/JulienKode/team-labeler-action/issues)

[![GitHub forks](https://img.shields.io/github/forks/JulienKode/team-labeler-action?style=flat-square)](https://github.com/JulienKode/team-labeler-action/network)

[![GitHub stars](https://img.shields.io/github/stars/JulienKode/team-labeler-action?style=flat-square)](https://github.com/JulienKode/team-labeler-action/stargazers)

[![GitHub license](https://img.shields.io/github/license/JulienKode/team-labeler-action?style=flat-square)](https://github.com/JulienKode/team-labeler-action/blob/master/LICENSE)

[![Watch on GitHub](https://img.shields.io/github/watchers/JulienKode/team-labeler-action.svg?style=social)](https://github.com/JulienKode/team-labeler-action/watchers)

[![Tweet](https://img.shields.io/twitter/url/https/github.com/JulienKode/team-labeler-action.svg?style=social)](https://twitter.com/intent/tweet?text=Checkout%20this%20library%20https%3A%2F%2Fgithub.com%2FJulienKode%2Fteam-labeler-action)

This repository provides a **GitHub action** to automatically **team label** on a **pull request** based author team.

This is useful if multiple team are working on the same project.

![example](./assets/example.png)

## Configuration

### Create `.github/teams.yml`

You need to provide a yml file that contains members of your teams:

```yaml

LightSide:

  - '@Yoda'

  - '@Luke'

DarkSide:

  - '@DarkVador'

  - '@Palpatine'

```

## Usage

### Create `.github/workflows/team-labeler.yml`

Create a workflow (eg: `.github/workflows/team-labeler.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) to utilize the labeler action.

This action only needs the GITHUB_TOKEN secret as it interacts with the GitHub API to modify labels. It's working for pull request and issues. The action can be used as such:

```yaml

on:

  pull_request:

  issues:

name: team-label

permissions:

  contents: read

  pull-requests: write

jobs:

  team-labeler:

    runs-on: ubuntu-latest

    steps:

    - uses: JulienKode/[email protected]

      with:

        repo-token: "${{ secrets.GITHUB_TOKEN }}"

```