-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update Action.yml and README.md
- Loading branch information
Showing
2 changed files
with
5 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,10 @@ | ||
# Enforce Pull Request Description Length Action | ||
# Enforce Active Pull Request is Assigned | ||
|
||
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. | ||
This action checks that an Active (Non-Draft) Pull Request has been Assigned to a User. | ||
|
||
## 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 | ||
uses: ryanvade/enforce-active-pr-assigned-action@v1 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,5 @@ | ||
name: Enforce Pull Request Description Length | ||
description: Check that a PR description is filled out | ||
inputs: | ||
minLength: | ||
description: 'Specific minimum length the descrption must be.' | ||
required: false | ||
name: Enforce Active Pull Request is Assigned | ||
description: Check that a PR which is out of Draft status has been assigned. | ||
runs: | ||
using: node12 | ||
main: dist/index.js |