Skip to content

Commit d249862

Browse files
author
repo-visualizer
committed
add branch param to docs
1 parent f68a97b commit d249862

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ The commit message to use when updating the diagram. Useful for skipping CI. For
3636

3737
Default: `Repo visualizer: updated diagram`
3838

39+
## `branch`
40+
41+
The branch name to push the diagram to (branch will be created if it does not yet exist).
42+
43+
For example: `diagram`
44+
3945
## Example usage
4046

4147
You'll need to run the `actions/checkout` Action beforehand, to check out the code.

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ inputs:
1515
description: "The commit message to use when updating the diagram. Default: Repo visualizer: updated diagram"
1616
required: false
1717
branch:
18-
description: "If you want to push the diagram to a different branch (branch will be created if it does not exist)"
18+
description: "The branch name to push the diagram to (branch will be created if it does not yet exist). For example: diagram"
1919
required: false
2020
runs:
2121
using: "node12"

0 commit comments

Comments
 (0)