setup-php/node_modules/@actions/core/README.md

107 lines
2.6 KiB
Markdown
Raw Normal View History

2019-09-06 06:47:43 +07:00
# `@actions/core`
> Core functions for setting results, logging, registering secrets and exporting variables across actions
## Usage
2019-10-11 06:11:25 +07:00
### Import the package
2019-09-06 06:47:43 +07:00
```js
2019-10-11 06:11:25 +07:00
// javascript
2019-09-06 06:47:43 +07:00
const core = require('@actions/core');
2019-10-11 06:11:25 +07:00
// typescript
import * as core from '@actions/core';
```
2019-09-06 06:47:43 +07:00
2019-10-11 06:11:25 +07:00
#### 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 });
2019-09-06 06:47:43 +07:00
core.setOutput('outputKey', 'outputVal');
```
#### Exporting variables
2019-10-11 06:11:25 +07:00
Since each step runs in a separate process, you can use `exportVariable` to add it to this step and future steps environment blocks.
2019-09-06 06:47:43 +07:00
```js
2019-10-11 06:11:25 +07:00
core.exportVariable('envVar', 'Val');
```
2019-09-06 06:47:43 +07:00
2019-10-11 06:11:25 +07:00
#### Setting a secret
2019-09-06 06:47:43 +07:00
2019-10-11 06:11:25 +07:00
Setting a secret registers the secret with the runner to ensure it is masked in logs.
```js
core.setSecret('myPassword');
2019-09-06 06:47:43 +07:00
```
#### PATH Manipulation
2019-10-11 06:11:25 +07:00
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.
2019-09-06 06:47:43 +07:00
```js
2019-10-11 06:11:25 +07:00
core.addPath('/path/to/mytool');
2019-09-06 06:47:43 +07:00
```
#### Exit codes
2019-10-11 06:11:25 +07:00
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.
2019-09-06 06:47:43 +07:00
```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}`);
}
2019-10-11 06:11:25 +07:00
Note that `setNeutral` is not yet implemented in actions V2 but equivalent functionality is being planned.
2019-09-06 06:47:43 +07:00
```
#### 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');
}
// Do stuff
}
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
})
```