generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Peter Grainger
committed
Sep 19, 2019
1 parent
2a3041d
commit e054175
Showing
1 changed file
with
11 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' |