mirror of https://github.com/actions/toolkit
Some more in the docs
parent
db9fd45770
commit
ea2ffbe002
|
@ -8,7 +8,7 @@ Its main purpose will be to provide a hydrated GitHub context/Octokit client wit
|
|||
|
||||
##### interfaces.ts
|
||||
|
||||
```
|
||||
```ts
|
||||
/*
|
||||
* Interfaces
|
||||
*/
|
||||
|
@ -56,7 +56,7 @@ export interface WebhookPayloadWithRepository {
|
|||
|
||||
Contains a GitHub context
|
||||
|
||||
```
|
||||
```ts
|
||||
export class Context {
|
||||
/**
|
||||
* Webhook payload object that triggered the workflow
|
||||
|
@ -89,7 +89,7 @@ export class Context {
|
|||
|
||||
Contains a hydrated Octokit client
|
||||
|
||||
```
|
||||
```ts
|
||||
export class GithubClient extends Octokit {
|
||||
// For making GraphQL requests
|
||||
public graphql: (query: string, variables?: Variables) => Promise<GraphQlQueryResponse>
|
||||
|
|
|
@ -6,7 +6,7 @@ In order to support the node-config action, I propose adding the following into
|
|||
|
||||
Holds all the functions necessary for interacting with the runner/environment.
|
||||
|
||||
```
|
||||
```ts
|
||||
// Logging functions
|
||||
export function debug(message: string): void
|
||||
export function warning(message: string): void
|
||||
|
@ -66,7 +66,7 @@ export function setFailed(message: string): void
|
|||
|
||||
Holds all the functions necessary for file system manipulation (cli scenarios, not fs replacements):
|
||||
|
||||
```
|
||||
```ts
|
||||
/**
|
||||
* Interface for cp/mv options
|
||||
*/
|
||||
|
@ -132,7 +132,7 @@ export function which(tool: string, options?: WhichOptions): Promise<string>
|
|||
|
||||
Holds all the functions necessary for running the tools node-config depends on (aka 7-zip and tar)
|
||||
|
||||
```
|
||||
```ts
|
||||
/**
|
||||
* Interface for exec options
|
||||
*/
|
||||
|
@ -155,7 +155,7 @@ export function exec(commandLine: string, args?: string[], options?: IExecOption
|
|||
|
||||
Holds all the functions necessary for downloading and caching node.
|
||||
|
||||
```
|
||||
```ts
|
||||
/**
|
||||
* Download a tool from an url and stream it into a file
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue