https://github.com/eps1lon/actions-label-merge-conflict

GitHub action that adds a label once a PR has merge conflicts
https://github.com/eps1lon/actions-label-merge-conflict

Last synced: 7 days ago
JSON representation

GitHub action that adds a label once a PR has merge conflicts

• Host: GitHub
• URL: https://github.com/eps1lon/actions-label-merge-conflict
• Owner: eps1lon
• Created: 2020-03-18T10:55:49.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:49:34.000Z (2 months ago)
• Last Synced: 2024-10-29T19:03:10.186Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 695 KB
• Stars: 47
• Watchers: 6
• Forks: 16
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# label merge-conflict action

This action adds a given label to Pull Requests that have merge conflicts and removes a given label from these pull requests

![label lifecycle: open (no label), push to main -> merge conflict -> label: PR needs rebase -> resolve conflicts on PR -> remove label: PR needs rebase](https://raw.githubusercontent.com/eps1lon/actions-label-merge-conflict/main/label-lifecycle.png).

## Example usage

```yaml

name: "Maintenance"

on:

  # So that PRs touching the same files as the push are updated

  push:

  # So that the `dirtyLabel` is removed if conflicts are resolve

  # We recommend `pull_request_target` so that github secrets are available.

  # In `pull_request` we wouldn't be able to change labels of fork PRs

  pull_request_target:

    types: [synchronize]

jobs:

  main:

    runs-on: ubuntu-latest

    steps:

      - name: check if prs are dirty

        uses: eps1lon/actions-label-merge-conflict@v3

        with:

          dirtyLabel: "PR: needs rebase"

          removeOnDirtyLabel: "PR: ready to ship"

          repoToken: "${{ secrets.GITHUB_TOKEN }}"

          commentOnDirty: "This pull request has conflicts, please resolve those before we can evaluate the pull request."

          commentOnClean: "Conflicts have been resolved. A maintainer will review the pull request shortly."

```

You can use `eps1lon/actions-label-merge-conflict@main` instead to get the latest, experimental version.

## Why?

PRs are usually open for a few days until a maintainer can take a look. When this happens a Pull Request (PR) might already be outdated without the author being notified of this. A maintainer either has to resolve them (which takes time) or has to ping the author. This creates a feedback loop that can be reduced by this action.

This actions achieve this with minimal noise (no comment bloat) by adding a label to a PR if it has merge conflicts. This means the author has a single overview of which PRs need a rebase by using their list of created PRs. At the same time the maintainer has a simple filter for PRs that have merge conflicts.

### Motivation

- [isaacs/github#224: Notify when merge conflict arises](https://github.com/isaacs/github/issues/224)

## Inputs

### `dirtyLabel`

**Required** The name of the label that should be added once a PR has merge conflicts. This label is removed once a PR becomes mergable again.

### `repoToken`

**Required** Token for the repository. Can be passed in using {{ secrets.GITHUB_TOKEN }}

### `removeOnDirtyLabel`

The name of the label that should be removed once a PR has merge conflicts.

**Default**: No label is removed if a PR is marked as dirty.

### `retryAfter`

Number of seconds after which the mergable state is checked again if it is unknown (GitHub is still calculating it).

**Default**: 120

### `retryMax`

Number of times the script will check the mergable state aigain. After that it will print a warning.

**Default**: 5

### `continueOnMissingPermissions`

Boolean. Whether to continue or fail when the provided token is missing permissions. By default pull requests from a fork do not have access to secrets and get a read only github token, resulting in a failure to update tags.

**Default**: false

### `commentOnDirty`

String. Comment to add when the pull request is conflicting. Supports markdown.

**Default**: No comment is posted.

### `commentOnClean`

String. Comment to add when the pull request is not conflicting anymore. Supports markdown.

**Default**: No comment is posted.