Skip to content

Commit

Permalink
chore: Added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanvade committed Dec 11, 2020
1 parent 7a3eefa commit 7062a3e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Enforce Pull Request Description Length Action

This action checks that a Pull Request Description is at a minimum length. By default the minimum length is one. If a different minimum length is needed it can be passed in using an Action Input.

## Inputs

### `minLength`

A specific minimum length the description must be.

## Example Usage

```
- name: Enforce Jira Issue Key in Pull Request Title
uses: ryanvade/enforce-pr-description-length-action@v1
```

## Example Usage with a specific min length

```
- name: Enforce Jira Issue Key in Pull Request Title
uses: ryanvade/enforce-pr-description-length-action@v1
with:
minLength: 5
```

0 comments on commit 7062a3e

Please sign in to comment.