mirror of
https://github.com/actions/javascript-action.git
synced 2025-12-12 05:36:56 +00:00
update readme
This commit is contained in:
24
README.md
24
README.md
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
:rocket: Use this template to bootstrap the creation of a JavaScript action with tests, linting, a validation workflow and publishing.
|
: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
|
## 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
|
||||||
@@ -55,7 +57,9 @@ See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/R
|
|||||||
|
|
||||||
## Publish to a distribution branch
|
## Publish to a distribution branch
|
||||||
|
|
||||||
Comment out node_modules in .gitignore
|
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
|
```bash
|
||||||
# Dependency directories
|
# Dependency directories
|
||||||
# node_modules/
|
# node_modules/
|
||||||
@@ -63,15 +67,31 @@ Comment out node_modules in .gitignore
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git checkout -b releases/v1
|
$ git checkout -b releases/v1
|
||||||
|
$ git commit -a -m "prod dependencies"
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm prune --production
|
$ 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:
|
## 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
|
```yaml
|
||||||
uses: actions/javascript-action@v1
|
uses: actions/javascript-action@v1
|
||||||
|
|||||||
Reference in New Issue
Block a user