https://github.com/AlbertHernandez/working-label-action

GitHub Action to add labels depending if the pull request is ready to review
https://github.com/AlbertHernandez/working-label-action

Last synced: 6 days ago
JSON representation

GitHub Action to add labels depending if the pull request is ready to review

• Host: GitHub
• URL: https://github.com/AlbertHernandez/working-label-action
• Owner: AlbertHernandez
• License: mit
• Created: 2020-04-10T13:03:24.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T03:06:39.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T14:47:25.045Z (29 days ago)
• Language: JavaScript
• Homepage:
• Size: 8.44 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Add Labels Depending if the Pull Request Still in Progress
• fucking-awesome-actions - Add Labels Depending if the Pull Request Still in Progress
• awesome-workflows - Add Labels Depending if the Pull Request Still in Progress

README

        
💼

working-label-action




    Add labels depending if the pull request is ready to review



## Examples

Imagine we have a project with some owners, each time we create a pull request the owners are automatically assigned as reviewers. In some cases we continue working on the pull request becase we found some issue, and we want to notify to the other members of the project that we are continue working on this which means we don't want their review at this moment since the code is going to change. Here is where this action comes to help us.

We can configure 2 labels, on the one hand when is "**Ready to review**" and on the other hand when is "**Work in progress**". Each time you update the pull request the action will remove "Ready to review" and will add "Work in progress". 

## Usage

You can create a `.github/workflows/working-label.yml` file:

```yaml

name: Assign work in progress label when pull request is updated

on: [pull_request]

jobs:

  working_label:

    runs-on: ubuntu-latest

    name: Label working progress

    steps:

      - uses: AlbertHernandez/[email protected]

        with:

          work_in_progress_label: 'Work in progress'

          ready_to_review_label: 'Ready to review'

    env:

      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## Inputs

| Name | Description | Required |

|------|-------------|----------|

| work_in_progress_label | Label to indicate that a pull request still in progress. If this label is no created the action will create it | true |

| ready_to_review_label | Label to indicate that a pull request is ready to be reviewed. If this label is no created the action will create it | true |