Skip to content

Commit 5cd62f0

Browse files
readme tweak
1 parent d080a47 commit 5cd62f0

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/R
6666

6767
## Package for distribution
6868

69+
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.
70+
6971
Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.
7072

7173
Run package
@@ -74,7 +76,7 @@ Run package
7476
npm run package
7577
```
7678

77-
Since the packaged index.js is run from the dist folder, check it in.
79+
Since the packaged index.js is run from the dist folder.
7880

7981
```bash
8082
git add dist
@@ -84,13 +86,15 @@ git add dist
8486

8587
Users shouldn't consume the action from master since that would be latest code and actions can break compatibility between major versions.
8688

89+
Checkin to the v1 release branch
90+
8791
```bash
8892
$ git checkout -b v1
8993
$ git commit -a -m "v1 release"
9094
```
9195

9296
```bash
93-
$ git push origin releases/v1
97+
$ git push origin v1
9498
```
9599

96100
Your action is now published! :rocket:

0 commit comments

Comments
 (0)