# github-cooldown-action

> Force cooldown for issues and comments for new users

Latest version **1.0.0** (published 2021-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-cooldown-action
pnpm add github-cooldown-action
yarn add github-cooldown-action
bun add github-cooldown-action
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-01-06 |
| First published | 2021-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | osy |
| Maintainers | osy86 |
| Keywords | github actions, github |

## Links

- npm: https://www.npmjs.com/package/github-cooldown-action
- Repository: https://github.com/osy/github-cooldown-action
- Issues: https://github.com/osy/github-cooldown-action/issues
- npm.io page: https://npm.io/package/github-cooldown-action

## Dependencies (3)

- [@actions/core](https://npm.io/package/@actions/core.md) ^1.2.6
- [@actions/github](https://npm.io/package/@actions/github.md) ^4.0.0
- [@octokit/graphql](https://npm.io/package/@octokit/graphql.md) ^4.5.8

## Recent versions

- 1.0.0 (latest) — 2021-01-06

## README

# Github Cooldown Action

This action prints "Hello World" or "Hello" + the name of a person to greet to the log.

## Inputs

### `token`

**Required** A [Github Personal Token][1] with `repo` access. Used to perform delete actions.

### `repository`

The name of the repository to protect in the format `username/repository`. If left blank, the current repository will be used.

### `cooldownMinutes`

The minimum amount of time (in minutes) that a user is allowed to make a new issue or comment on an issue. Issues and comments are counted separately. The default cooldown is 10 minutes.

### `exemptAgeDays`

Accounts older than this (in days) will be exempt from cooldown rules. If 0, then no accounts are exempt. The default is 0 (no exemption).

### `maxNewIssues`

Number of issues permitted before triggering a cooldown. Default is 1. The count is separate from number of comments.

### `maxNewComments`

Number of comments permitted before triggering a cooldown. Default is 1. The count is separate from number of issues.

## Example usage

```yaml
name: Issues
on:
  issue_comment:
    types: [created]
  issues:
    types: [opened]
jobs:
  cooldown:
    name: Cooldown
    runs-on: ubuntu-latest
    continue-on-error: true
    steps:
    - name: Cooldown
      uses: osy/github-cooldown-action@v1.0
      with:
        token: ${{ secrets.COOLDOWN_TOKEN }}
        exemptAgeDays: 365
```

[1]: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token

---
_Source: https://npm.io/package/github-cooldown-action · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._