From 5cd62f0ad82f392f3df35539388f96df5375629e Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Tue, 22 Oct 2019 22:50:26 -0400 Subject: [PATCH] readme tweak --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de40ec6..9b95d16 100644 --- a/README.md +++ b/README.md @@ -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: