@actions/github
- Version 6.0.0
- Published
- 23.6 kB
- 4 dependencies
- MIT license
Install
npm i @actions/github
yarn add @actions/github
pnpm add @actions/github
Overview
Actions github lib
Index
Variables
Functions
Variables
variable context
const context: Context.Context;
Functions
function getOctokit
getOctokit: ( token: string, options?: OctokitOptions, ...additionalPlugins: OctokitPlugin[]) => InstanceType<typeof GitHub>;
Returns a hydrated octokit ready to use for GitHub Actions
Parameter token
the repo PAT or GITHUB_TOKEN
Parameter options
other options to set
Package Files (1)
Dependencies (4)
Dev Dependencies (1)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@actions/github
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@actions/github)
- HTML<a href="https://www.jsdocs.io/package/@actions/github"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2619 ms. - Missing or incorrect documentation? Open an issue for this package.