2525b376e4
`execSync` by default spawns a shell to exec the specified command. And, without specifying an absolute path to the node binary, it will be searched in `PATH` where yarn prepends a temporary directory containing a shell script called **node** that wraps the original node binary with exec, resulting in implicitly chaining a shell again. On some Linux distros, the default non-interactive shell, such as the Dash shell of Debian, silently discards dashes (`-`) in names of environment variables. But GitHub Actions allows dashes in names of input variables which are then converted to environment variables in the form of `INPUT_<VARIABLE_NAME>`. So the commit fix the error-prone test code by using execFileSync, which by default exec directly without spawning a shell, to run node with its absolute path. |
||
|---|---|---|
| .github | ||
| __tests__ | ||
| dist | ||
| src | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| LICENSE | ||
| README.md | ||
| action.yml | ||
| jest.config.js | ||
| package-lock.json | ||
| package.json | ||
| tsconfig.json | ||
Create a JavaScript Action using TypeScript
Use this template to bootstrap the creation of a TypeScript action.🚀
This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.
If you are new, there's also a simpler introduction. See the 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 Main
Install the dependencies
$ npm install
Build the typescript and package it for distribution
$ npm run build && npm run package
Run the tests ✔️
$ 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
Change the Code
Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
import * as core from '@actions/core';
...
async function run() {
try {
...
}
catch (error) {
core.setFailed(error.message);
}
}
run()
See the toolkit documentation for the various packages.
Publish to a distribution branch
Actions are run from GitHub repos so we will checkin the packed dist folder.
Then run ncc and push the results:
$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.
Your action is now published! 🚀
See the versioning documentation
Validate
You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)
uses: ./
with:
milliseconds: 1000
See the actions tab for runs of this action! 🚀
Usage:
After testing you can create a v1 tag to reference the stable and latest V1 action