Skip to content

Commit

Permalink
Add README.md for script
Browse files Browse the repository at this point in the history
  • Loading branch information
jimchamp committed Jan 23, 2024
1 parent b791d03 commit b7f8308
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions scripts/gh_scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# GitHub Project Management Scripts

This directory contains scripts that the Open Library team uses to interact with this GitHub repository.

## `auto_unassigner.mjs`

This script fetches all open issues that have assignees and automatically removes assignees that meet the following criteria:
- Assignee has been assigned for more than 14 days and has not created and linked a pull request to the issue.
- Assignee's GitHub username does not appear on the exclude list.

This script skips over issues that have the `no-automation` label.

This script takes two options:
- `--daysSince` Integer that defines the number of days until an assignee is stale. Defaults to `14`.
- `--repoOwner` String that defines the specific `openlibrary` repository. Defaults to `internetarchive`.

> [!IMPORTANT]
> Include a space between an option and its value when calling this script.
__Correct:__
`node auto_unassigner.mjs --daysSince 21`

__Incorrect:__
`node auto_unassigner.mjs --daysSince=21`

The GitHub action that runs this script automatically sets `--repoOwner` to the owner of the repository that triggered the action.

0 comments on commit b7f8308

Please sign in to comment.