113 lines
2.8 KiB
Markdown
113 lines
2.8 KiB
Markdown
|
|
<p align="center">
|
|
<a href="https://github.com/actions/javascript-action"><img alt="GitHub Actions status" src="https://github.com/actions/javascript-action/workflows/Run%20JavaScript%20Action/badge.svg"></a>
|
|
</p>
|
|
|
|
# Create a JavaScript Action
|
|
|
|
Use this template to bootstrap the creation of a JavaScript action.:rocket:
|
|
|
|
This template includes tests, linting, a validation workflow, publishing, and versioning guidance.
|
|
|
|
If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
|
|
|
|
## Create an action from this template
|
|
|
|
Click the `Use this Template` and provide the new repo details for your action
|
|
|
|
## Code in Master
|
|
|
|
Install the dependencies
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
Run the tests :heavy_check_mark:
|
|
```bash
|
|
$ npm test
|
|
|
|
PASS ./index.test.js
|
|
✓ throws invalid number (3ms)
|
|
✓ wait 500 ms (504ms)
|
|
✓ test runs (95ms)
|
|
|
|
...
|
|
```
|
|
|
|
## Change action.yml
|
|
|
|
The action.yml contains defines the inputs and output for your action.
|
|
|
|
Update the action.yml with your name, description, inputs and outputs for your action.
|
|
|
|
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
|
|
|
|
## Change the Code
|
|
|
|
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
|
|
|
|
```javascript
|
|
const core = require('@actions/core');
|
|
...
|
|
|
|
async function run() {
|
|
try {
|
|
...
|
|
}
|
|
catch (error) {
|
|
core.setFailed(error.message);
|
|
}
|
|
}
|
|
|
|
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
|
|
# comment this out distribution branches
|
|
# 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
|
|
```
|
|
|
|
Your action is now published! :rocket:
|
|
|
|
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
|
|
```
|
|
|
|
See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
|
|
|
|
## Usage:
|
|
|
|
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
|
|
``` |