actions
/
typescript-action
Template
mirror of https://github.com/actions/typescript-action.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md with some small unifying changes 

This is a PR to unify the `README.md` file with some little changes.
This commit is contained in:
claire-gallesio 2023-07-19 10:06:01 +02:00 committed by GitHub
parent dfe9c58e43
commit 235529d41a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -4,21 +4,21 @@
# Create a JavaScript Action using TypeScript
Use this template to bootstrap the creation of a TypeScript action.:rocket:
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.
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
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
## Create an Action from this template
Click the `Use this Template` and provide the new repo details for your action
Click the `Use this Template` and provide the new repo details for your action.
## Code in Main
> 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
```
@ -40,11 +40,11 @@ $ npm test
...
```
## Change action.yml
## Change `action.yml`
The action.yml defines the inputs and output for your action.
The `action.yml` defines the inputs and output for your action.
Update the action.yml with your name, description, inputs and outputs 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)
@ -98,8 +98,8 @@ with:
milliseconds: 1000
```
See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
See the [Actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
## Usage:
## Usage
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
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.