diff --git a/README.md b/README.md index fac1dd6..a6a0b11 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Use this template to bootstrap the creation of a TypeScript action.:rocket: -This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. +This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) @@ -18,7 +18,7 @@ Click the `Use this Template` and provide the new repo details for your action > First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance. -Install the dependencies +Install the dependencies ```bash $ npm install ``` @@ -28,7 +28,7 @@ Build the typescript and package it for distribution $ npm run build && npm run package ``` -Run the tests :heavy_check_mark: +Run the tests :heavy_check_mark: ```bash $ npm test @@ -57,9 +57,9 @@ import * as core from '@actions/core'; ... async function run() { - try { + try { ... - } + } catch (error) { core.setFailed(error.message); } @@ -72,7 +72,7 @@ See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/R ## Publish to a distribution branch -Actions are run from GitHub repos so we will checkin the packed dist folder. +Actions are run from GitHub repos so we will checkin the packed dist folder. Then run [ncc](https://github.com/zeit/ncc) and push the results: ```bash @@ -84,7 +84,7 @@ $ git push origin releases/v1 Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. -Your action is now published! :rocket: +Your action is now published! :rocket: See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)