Skip to content

Commit e054175

Browse files
author
Peter Grainger
committed
add a readme to the action
1 parent 2a3041d commit e054175

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
# Create a JavaScript Action using TypeScript
1+
# Create Branch Github Action
22

3-
This template offers an easy way to get started writing a JavaScript action with TypeScript compile time support, unit testing with Jest and using the GitHub Actions Toolkit.
3+
This action creates a new branch with the same commit reference as the branch it is being ran on.
44

5-
## Getting Started
5+
## Inputs
66

7-
See the walkthrough located [here](https://github.com/actions/toolkit/blob/master/docs/typescript-action.md).
7+
### `branch`
88

9-
In addition to walking your through how to create an action, it also provides strategies for versioning, releasing and referencing your actions.
9+
**Optional** The name of the branch to create. Default `"release-candidate"`.
10+
11+
## Example usage
12+
13+
uses: peterjgrainger/[email protected]
14+
with:
15+
branch: 'release-notes'

0 commit comments

Comments
 (0)