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

readme tweak

This commit is contained in:
Bryan MacFarlane 2019-10-22 22:50:26 -04:00
parent d080a47b66
commit 5cd62f0ad8
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -66,6 +66,8 @@ See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/R
## Package for distribution
GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.
Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
Run package
@ -74,7 +76,7 @@ Run package
npm run package
```
Since the packaged index.js is run from the dist folder, check it in.
Since the packaged index.js is run from the dist folder.
```bash
git add dist
@ -84,13 +86,15 @@ git add dist
Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
Checkin to the v1 release branch
```bash
$ git checkout -b v1
$ git commit -a -m "v1 release"
```
```bash
$ git push origin releases/v1
$ git push origin v1
```
Your action is now published! :rocket: