Skip to content

Commit aa43e40

Browse files
author
Kovacs Alex
committed
chore: add proper README
1 parent b68855d commit aa43e40

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
11
# action-build-typescript
2+
A GitHub action that can be used to build TypeScript code and then push that built code to a different branch
3+
4+
## Usage
5+
```yml
6+
name: Build
7+
on:
8+
push:
9+
branches:
10+
- master
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout project
16+
uses: actions/checkout@v2
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v2.1.4
19+
with:
20+
node-version: 12
21+
- name: Build and push
22+
uses: alexthemaster/action-build-typescript@latest
23+
with:
24+
pushToBranch: true # optional; can either be true or false | defaults to false
25+
branch: 'dist' # optional; the name of the branch the action should push the compiled code to | defaults to dist
26+
githubToken: ${{ secrets.GITHUB_TOKEN }} # required if you use the pushToBranch option
27+
```

0 commit comments

Comments
 (0)