Skip to content

Commit

Permalink
Fix up README slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
LostLuma committed Nov 25, 2023
1 parent f195a02 commit f82832b
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# PythonistaGuild PR Description Check Action
# Pythonista PR Description Check Action

A small action to check whether specific strings are contained in the body/description of a PR.


Useful for checking whether certain conditions have been agreed to E.g. with [x] or []
Action which checks whether a specific string is contained within a PR description.
This is useful for checking whether certain conditions have been met, e.g. signing an agreement.

## To Use:

**Make a workflow:**
**Create a workflow:**

```yaml
name: pr-description-check
name: validate-description
on:
pull_request:
types:
Expand All @@ -21,10 +19,9 @@ jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: checkout repository
uses: actions/checkout@v4
- name: PR Description Check
uses: pythonistaguild/pr-description-check@v1.0
with:
content: "string to check exists"
# Check whether the author has enabled this checkbox
content: "[x] Python is my favorite programming language!"
```

0 comments on commit f82832b

Please sign in to comment.