https://github.com/kyle-west/action-review-rotation
Rotate through a list of reviewers for reviewing a PR
https://github.com/kyle-west/action-review-rotation
Last synced: 3 months ago
JSON representation
Rotate through a list of reviewers for reviewing a PR
- Host: GitHub
- URL: https://github.com/kyle-west/action-review-rotation
- Owner: kyle-west
- Created: 2021-01-21T00:02:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-22T18:13:08.000Z (over 4 years ago)
- Last Synced: 2025-02-01T22:21:46.563Z (4 months ago)
- Language: JavaScript
- Size: 3.26 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# _Picky_ Review Rotation
Github Action that rotates through a list of reviewers by a specified interval
## Inputs
### `reviewers`
**REQUIRED** A whitespace separated list of reviewers and/or teams for reviewing
### `rotation`
The frequency of rotation (e.g. "2 days", "4 weeks", "3 months", "1 year"). Default is `1 week`.
### `fetch-team-users`
Boolean if the rotation list should expand teams to individual members from teams given
### `token`
A github token to access team members if `fetch-team-users` is true
## Outputs:
### `reviewer`
The assigned reviewer or team
### `team`
The team the reviewer belongs to (if applicable)
### `calendar`
The immediate review schedule. Example: _team1 will review from Today until 3/25/2021. team2 will review from 3/26/2021 until 4/16/2021._
## Example usage
```yml
- uses: kyle-west/[email protected]
id: getRev
with:
reviewers: kyle-west digital-taco/admin digital-taco/qa
rotation: 4 Weeks
- run: echo "reviewer is ${{ steps.getRev.outputs.reviewer }}"
- run: echo "calendar is ${{ steps.getRev.outputs.calendar }}"
```