Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/ready-for-review-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Ready-for-review label

# When a pull-request changes state (closed, converted to draft) or a review is submitted/dismissed,
# run the `manage-ready-for-review.yml` workflow, to remove the
# "ready-for-review" label from a PR if its no longer needed.
#
# `pull_request_target` (rather than `pull_request`) is required so that the job
# has a read/write token for pull requests opened from forks. This is safe here
Comment thread
simongdavies marked this conversation as resolved.
# because the reusable workflow never checks out or executes pull-request code.
#
# The label removal workflow lives in hyperlight-dev's `.github` repository. To apply this workflow
# to another repository, copy this file to that repo.
on:
pull_request_target:
types: [closed, converted_to_draft]
pull_request_review:
types: [submitted, dismissed]

# Serialise runs per pull request so that concurrent events cannot race.
concurrency:
group: ready-for-review-${{ github.event.pull_request.number }}
cancel-in-progress: false

permissions:
contents: read
pull-requests: read
issues: write
jobs:
manage-label:
# Shared workflow in the org-wide `.github` repository, pinned to a commit SHA
uses: hyperlight-dev/.github/.github/workflows/manage-ready-for-review.yml@55e0ed4457b40f371ec9b6f2828397b09a833a43
with:
pr-number: ${{ github.event.pull_request.number }}
13 changes: 13 additions & 0 deletions docs/github-labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ We use GitHub labels to categorize PRs. Before a PR can be merged, it must be as
- **kind/enhancement** - For PRs that introduce new features or improve existing functionality. This label also applies to improvements in documentation, testing, and similar areas. Any changes must be backward-compatible.
- **kind/refactor** - For PRs that restructure or remove code without adding new functionality. This label also applies to changes that affect user-facing APIs.

## Review readiness

We use the **ready-for-review** label to signal that a PR is waiting for a (re-)review:

- **Add** `ready-for-review` when you open a PR that is ready for review, or when a PR is ready for re-review (for example, once you have addressed requested changes and re-requested review).
- The label is **removed automatically** by the [`Ready-for-review label`](../.github/workflows/ready-for-review-label.yml) workflow once the PR is no longer awaiting that review, specifically when any of the following become true:
- the PR is closed or merged,
- the PR is converted to a draft,
- the PR has two or more approvals, or
- the PR has two or more change requests.

You only ever need to add the label; removal is fully automated.

---

# **Issues**
Expand Down
Loading