2019-12-07 18:40:49 +00:00
< p align = "center" >
< a href = "https://github.com/actions/typescript-action/actions" > < img alt = "typescript-action status" src = "https://github.com/actions/typescript-action/workflows/build-test/badge.svg" > < / a >
< / p >
2019-09-15 22:08:36 +00:00
# Create a JavaScript Action using TypeScript
2019-07-22 18:15:40 +00:00
2020-07-17 12:57:25 +00:00
Use this template to bootstrap the creation of a TypeScript action.:rocket:
2019-08-09 18:53:04 +00:00
2020-07-17 12:57:06 +00:00
This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.
2019-08-09 18:53:04 +00:00
2019-09-21 12:56:30 +00:00
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action ](https://github.com/actions/hello-world-javascript-action )
## Create an action from this template
Click the `Use this Template` and provide the new repo details for your action
## Code in Master
Install the dependencies
```bash
$ npm install
```
2020-02-28 12:56:12 +00:00
Build the typescript and package it for distribution
2019-09-21 12:56:30 +00:00
```bash
2020-02-28 12:56:12 +00:00
$ npm run build & & npm run pack
2019-09-21 12:56:30 +00:00
```
Run the tests :heavy_check_mark:
```bash
$ npm test
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
...
```
## Change action.yml
The action.yml contains defines the inputs and output for your action.
Update the action.yml with your name, description, inputs and outputs for your action.
See the [documentation ](https://help.github.com/en/articles/metadata-syntax-for-github-actions )
## Change the Code
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
```javascript
import * as core from '@actions/core';
...
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()
```
See the [toolkit documentation ](https://github.com/actions/toolkit/blob/master/README.md#packages ) for the various packages.
## Publish to a distribution branch
2020-02-28 14:51:10 +00:00
Actions are run from GitHub repos so we will checkin the packed dist folder.
2019-09-21 12:56:30 +00:00
2020-02-28 12:56:12 +00:00
Then run [ncc ](https://github.com/zeit/ncc ) and push the results:
2019-09-21 12:56:30 +00:00
```bash
2020-02-28 12:56:12 +00:00
$ npm run pack
$ git add dist
2019-09-21 12:56:30 +00:00
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
Your action is now published! :rocket:
See the [versioning documentation ](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md )
## Validate
2020-02-28 14:51:10 +00:00
You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml ](.github/workflows/test.yml )])
2019-09-21 12:56:30 +00:00
```yaml
2020-02-28 14:51:10 +00:00
uses: ./
2019-09-21 12:56:30 +00:00
with:
milliseconds: 1000
```
See the [actions tab ](https://github.com/actions/javascript-action/actions ) for runs of this action! :rocket:
## Usage:
2020-02-28 14:51:10 +00:00
After testing you can [create a v1 tag ](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md ) to reference the stable and latest V1 action