actions/toolkit
2
0
Fork 0
mirror of https://github.com/actions/toolkit.git synced 2026-08-11 00:00:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

octokit client should follow proxy settings (#314)

Browse Source
This commit is contained in:
eric sciple
2020-01-18 14:28:37 -05:00
committed by GitHub
parent e69833ed16
commit ab5bd9d696
18 changed files with 473 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/github/README.md
+2 -2
View File
@@ -4,7 +4,7 @@
## Usage
Returns an Octokit client. See https://octokit.github.io/rest.js for the API.
Returns an authenticated Octokit client that follows the machine [proxy settings](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners#using-a-proxy-server-with-self-hosted-runners). See https://octokit.github.io/rest.js for the API.
```js
const github = require('@actions/github');
@@ -34,7 +34,7 @@ async function run() {
run();
```
You can pass client options (except `auth`, which is handled by the token argument), as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor.
You can pass client options, as specified by [Octokit](https://octokit.github.io/rest.js/), as a second argument to the `GitHub` constructor.
You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API.