Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Document required permissions #13

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,20 @@ 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
permissions: {}

jobs:
pullrequest:
# ...
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
```
Loading