enqueue-pullrequest/action.yml at main · waheedahmed/enqueue-pullrequest · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
name: "Enqueue Pull Request"
description: "Automatically enqueue pull requests into GitHub's native merge queue based on labels and review status"
author: "waheedahmed"

inputs:
  github-token:
    description: >
      GitHub token used to call the API. Needs `pull-requests: write` and
      `repository-projects: read` permissions. Defaults to the built-in
      GITHUB_TOKEN, but a PAT is recommended so that the action can trigger
      subsequent workflows.
    required: false
    default: "${{ github.token }}"

  label:
    description: >
      Label that triggers adding a PR to the merge queue.
      Set to an empty string to process every open PR regardless of labels.
    required: false
    default: "enqueue-pullrequest"

  branch:
    description: >
      Head branch name used to filter pull requests for broad events
      (schedule, workflow_dispatch, push, etc.). When provided only PRs whose
      head branch matches this value are processed. Leave empty to process all
      open PRs.
    required: false
    default: ""

  skip-labels:
    description: >
      Comma-separated list of labels that prevent a PR from being added to the
      merge queue (e.g. "wip, do-not-enqueue, blocked").
    required: false
    default: ""

  base-branches:
    description: >
      Comma-separated list of base branch names to limit processing to.
      Leave empty to process PRs targeting any branch.
    required: false
    default: ""

  skip-drafts:
    description: "When true, draft pull requests are skipped."
    required: false
    default: "true"

  required-approvals:
    description: >
      Minimum number of approving reviews required before a PR is enqueued.
      Set to 0 to skip this check and rely solely on branch-protection rules.
    required: false
    default: "0"

  enqueue-retries:
    description: >
      Number of times to retry enqueuing if it fails. Default is 6. Set to 0 to disable retry logic.
    required: false
    default: "6"

  enqueue-retry-sleep:
    description: >
      Time (in milliseconds) to sleep between retries. Default is 5000 (5 seconds). Set to 0 to disable sleeping between retries.
    required: false
    default: "5000"

runs:
  using: "node22"
  main: "dist/index.js"

branding:
  icon: "git-merge"
  color: "orange"