mirror of https://github.com/actions/setup-go.git
				
				
				
			|  3b60f67c92 | ||
|---|---|---|
| .. | ||
| lib | ||
| LICENSE.md | ||
| README.md | ||
| package.json | ||
		
			
				
				README.md
			
		
		
			
			
		
	
	@actions/core
Core functions for setting results, logging, registering secrets and exporting variables across actions
Usage
Inputs/Outputs
You can use this library to get inputs or set outputs:
const core = require('@actions/core');
const myInput = core.getInput('inputName', { required: true });
// Do stuff
core.setOutput('outputKey', 'outputVal');
Exporting variables/secrets
You can also export variables and secrets for future steps. Variables get set in the environment automatically, while secrets must be scoped into the environment from a workflow using {{ secret.FOO }}. Secrets will also be masked from the logs:
const core = require('@actions/core');
// Do stuff
core.exportVariable('envVar', 'Val');
core.exportSecret('secretVar', variableWithSecretValue);
PATH Manipulation
You can explicitly add items to the path for all remaining steps in a workflow:
const core = require('@actions/core');
core.addPath('pathToTool');
Exit codes
You should use this library to set the failing exit code for your action:
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}`);
}
Logging
Finally, this library provides some utilities for logging:
const core = require('@actions/core');
const myInput = core.getInput('input');
try {
  core.debug('Inside try block');
  
  if (!myInput) {
    core.warning('myInput wasnt set');
  }
  
  // Do stuff
}
catch (err) {
  core.error('Error ${err}, action may still succeed though');
}