mirror of https://github.com/actions/toolkit
148 lines
3.2 KiB
Markdown
148 lines
3.2 KiB
Markdown
# `@actions/core`
|
|
|
|
> Core functions for setting results, logging, registering secrets and exporting variables across actions
|
|
|
|
## Usage
|
|
|
|
### Import the package
|
|
|
|
```js
|
|
// javascript
|
|
const core = require('@actions/core');
|
|
|
|
// typescript
|
|
import * as core from '@actions/core';
|
|
```
|
|
|
|
#### Inputs/Outputs
|
|
|
|
Action inputs can be read with `getInput`. Outputs can be set with `setOutput` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.
|
|
|
|
```js
|
|
const myInput = core.getInput('inputName', { required: true });
|
|
|
|
core.setOutput('outputKey', 'outputVal');
|
|
```
|
|
|
|
#### Exporting variables
|
|
|
|
Since each step runs in a separate process, you can use `exportVariable` to add it to this step and future steps environment blocks.
|
|
|
|
```js
|
|
core.exportVariable('envVar', 'Val');
|
|
```
|
|
|
|
#### Setting a secret
|
|
|
|
Setting a secret registers the secret with the runner to ensure it is masked in logs.
|
|
|
|
```js
|
|
core.setSecret('myPassword');
|
|
```
|
|
|
|
#### PATH Manipulation
|
|
|
|
To make a tool's path available in the path for the remainder of the job (without altering the machine or containers state), use `addPath`. The runner will prepend the path given to the jobs PATH.
|
|
|
|
```js
|
|
core.addPath('/path/to/mytool');
|
|
```
|
|
|
|
#### Exit codes
|
|
|
|
You should use this library to set the failing exit code for your action. If status is not set and the script runs to completion, that will lead to a success.
|
|
|
|
```js
|
|
const core = require('@actions/core');
|
|
|
|
try {
|
|
// Do stuff
|
|
}
|
|
catch (err) {
|
|
// setFailed logs the message and sets a failing exit code
|
|
core.setFailed(`Action failed with error ${err}`);
|
|
}
|
|
|
|
Note that `setNeutral` is not yet implemented in actions V2 but equivalent functionality is being planned.
|
|
|
|
```
|
|
|
|
#### Logging
|
|
|
|
Finally, this library provides some utilities for logging. Note that debug logging is hidden from the logs by default. This behavior can be toggled by enabling the [Step Debug Logs](../../docs/action-debugging.md#step-debug-logs).
|
|
|
|
```js
|
|
const core = require('@actions/core');
|
|
|
|
const myInput = core.getInput('input');
|
|
try {
|
|
core.debug('Inside try block');
|
|
|
|
if (!myInput) {
|
|
core.warning('myInput was not set');
|
|
}
|
|
|
|
if (core.isDebug()) {
|
|
// curl -v https://github.com
|
|
} else {
|
|
// curl https://github.com
|
|
}
|
|
|
|
// Do stuff
|
|
core.info('Output to the actions build log')
|
|
}
|
|
catch (err) {
|
|
core.error(`Error ${err}, action may still succeed though`);
|
|
}
|
|
```
|
|
|
|
This library can also wrap chunks of output in foldable groups.
|
|
|
|
```js
|
|
const core = require('@actions/core')
|
|
|
|
// Manually wrap output
|
|
core.startGroup('Do some function')
|
|
doSomeFunction()
|
|
core.endGroup()
|
|
|
|
// Wrap an asynchronous function call
|
|
const result = await core.group('Do something async', async () => {
|
|
const response = await doSomeHTTPRequest()
|
|
return response
|
|
})
|
|
```
|
|
|
|
#### Action state
|
|
|
|
You can use this library to save state and get state for sharing information between a given wrapper action:
|
|
|
|
**action.yml**
|
|
```yaml
|
|
name: 'Wrapper action sample'
|
|
inputs:
|
|
name:
|
|
default: 'GitHub'
|
|
runs:
|
|
using: 'node12'
|
|
main: 'main.js'
|
|
post: 'cleanup.js'
|
|
```
|
|
|
|
In action's `main.js`:
|
|
|
|
```js
|
|
const core = require('@actions/core');
|
|
|
|
core.saveState("pidToKill", 12345);
|
|
```
|
|
|
|
In action's `cleanup.js`:
|
|
```js
|
|
const core = require('@actions/core');
|
|
|
|
var pid = core.getState("pidToKill");
|
|
|
|
process.kill(pid);
|
|
```
|