update readme

This commit is contained in:
Bryan MacFarlane 2019-09-11 02:42:43 -04:00
parent db9d707eee
commit 22bde10b21

View File

@ -2,6 +2,8 @@
:rocket: Use this template to bootstrap the creation of a JavaScript action with tests, linting, a validation workflow and publishing.
This walk through takes you through creation, testing and publishing the action.
## Create an action from this template
Click the `Use this Template` and provide the new repo details for your action
@ -53,15 +55,46 @@ run()
See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
## Publish to a distribution branch
Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case).
Comment out node_modules in .gitignore and create a releases/v1 branch
```bash
# Dependency directories
# node_modules/
```
```bash
$ git checkout -b releases/v1
$ git commit -a -m "prod dependencies"
```
```bash
$ npm prune --production
$ git add node_modules/
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
## Validate
You can now validate the action by referencing the releases/v1 branch
```yaml
uses: actions/javascript-action@releases/v1
with:
milliseconds: 1000
```
## Usage:
The uses path will be the org and repo where you create your 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 tested action
```yaml
uses: actions/javascript-action@v1
with:
milliseconds: 1000
```
```