Skip to content

Commit 7a12681

Browse files
committed
feat(create-pr): Add docs
1 parent beb1fe2 commit 7a12681

File tree

4 files changed

+13
-3
lines changed

4 files changed

+13
-3
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,17 @@ The following parameters can be used for additional control over when it is safe
140140
### [create-pr](.github/workflows/create-pr.yml)
141141

142142
- Opens a pull request.
143+
- Can create a new branch and commit changes
144+
145+
| Parameter | Description | Default value | Required |
146+
| :-----------------: | :---------------------------------------------------------------------------------------------------------: | :-------------------: | :------: |
147+
| title | An issue title | N/A | ✔️ |
148+
| body | Description of the PR | N/A | ✔️ |
149+
| base | Base ref to initiate pull request onto | N/A | ❌ |
150+
| branch_name | Name of the branch to be created. Use this parameter if you want the helper to create a new branch for you. | N/A | ❌ |
151+
| commit_message | Text used when creating a commit if branch_name is given | Automated PR creation | ❌ |
152+
| head | Head ref to initiate pull request from. If branch_name is provided it'll be the value of head | N/A | ❌ |
153+
| return_full_payload | Return full payload from GitHub rather than a trimmed-down version of the response | N/A | ❌ |
143154

144155
### [create-project-card](.github/workflows/create-project-card.yml)
145156

dist/440.index.js

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/440.index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/helpers/create-pr.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import simpleGit from 'simple-git';
2020
export class CreatePR extends HelperInputs {
2121
title = '';
2222
body = '';
23-
commit_message: string = '';
23+
declare commit_message?: string;
2424
declare head?: string;
2525
declare base?: string;
2626
declare return_full_payload?: string;

0 commit comments

Comments
 (0)