Skip to content

Commit

Permalink
add a readme to the action
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Grainger committed Sep 19, 2019
1 parent 2a3041d commit e054175
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Create a JavaScript Action using TypeScript
# Create Branch Github Action

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.
This action creates a new branch with the same commit reference as the branch it is being ran on.

## Getting Started
## Inputs

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

In addition to walking your through how to create an action, it also provides strategies for versioning, releasing and referencing your actions.
**Optional** The name of the branch to create. Default `"release-candidate"`.

## Example usage

uses: peterjgrainger/[email protected]
with:
branch: 'release-notes'

0 comments on commit e054175

Please sign in to comment.