Skip to content

Commit

Permalink
DOC Document required permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz committed Apr 16, 2024
1 parent 3242d39 commit b0a81c3
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,18 @@ This action is intended as a step in a larger workflow and at a minimum the repo

**workflow.yml**
```yml
steps:
- name: Create pull-request
uses: silverstripe/gha-pull-request@v1
with:
branch: pulls/4/my-branch
title: NEW My pull-request title
description: (Optional) This text will appear in the body of the GitHub pull-request
job:
# ...
permissions:
contents: write
pull-request: write
actions: write
# ...
steps:
- name: Create pull-request
uses: silverstripe/gha-pull-request@v1
with:
branch: pulls/4/my-branch
title: NEW My pull-request title
description: (Optional) This text will appear in the body of the GitHub pull-request
```

0 comments on commit b0a81c3

Please sign in to comment.