Update octokit graphql type dependencies (#228)

* Update GraphQL support in base API
actions · Dec 6, 2019 · 5fdab2a · 5fdab2a
1 parent 1c12ced
commit 5fdab2a
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 81 deletions.
diff --git a/packages/github/RELEASES.md b/packages/github/RELEASES.md
@@ -1,5 +1,9 @@
 # @actions/github Releases
 
+### 2.0.0
+
+- Upgrade Octokit version to 4.x to include typescript types [#228](https://github.com/actions/toolkit/pull/228)
+
 ### 1.1.0
 
 - Accept Octokit.Options in the GitHub constructor [#113](https://github.com/actions/toolkit/pull/113)

diff --git a/packages/github/package-lock.json b/packages/github/package-lock.json
diff --git a/packages/github/package.json b/packages/github/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@actions/github",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Actions github lib",
   "keywords": [
     "github",
@@ -27,13 +27,15 @@
   "scripts": {
     "test": "jest",
     "build": "tsc",
+    "format": "prettier --write **/*.ts",
+    "format-check": "prettier --check **/*.ts",
     "tsc": "tsc"
   },
   "bugs": {
     "url": "https://github.com/actions/toolkit/issues"
   },
   "dependencies": {
-    "@octokit/graphql": "^2.0.1",
+    "@octokit/graphql": "^4.3.1",
     "@octokit/rest": "^16.15.0"
   },
   "devDependencies": {

diff --git a/packages/github/src/@types/@octokit/index.d.ts b/packages/github/src/@types/@octokit/index.d.ts
diff --git a/packages/github/src/context.ts b/packages/github/src/context.ts
@@ -27,11 +27,8 @@ export class Context {
           readFileSync(process.env.GITHUB_EVENT_PATH, {encoding: 'utf8'})
         )
       } else {
-        process.stdout.write(
-          `GITHUB_EVENT_PATH ${
-            process.env.GITHUB_EVENT_PATH
-          } does not exist${EOL}`
-        )
+        const path = process.env.GITHUB_EVENT_PATH
+        process.stdout.write(`GITHUB_EVENT_PATH ${path} does not exist${EOL}`)
       }
     }
     this.eventName = process.env.GITHUB_EVENT_NAME as string

diff --git a/packages/github/src/github.ts b/packages/github/src/github.ts
@@ -1,5 +1,11 @@
 // Originally pulled from https://github.com/JasonEtco/actions-toolkit/blob/master/src/github.ts
-import {GraphQlQueryResponse, Variables, defaults} from '@octokit/graphql'
+import {graphql} from '@octokit/graphql'
+
+// we need this type to set up a property on the GitHub object
+// that has token authorization
+// (it is not exported from octokit by default)
+import {graphql as GraphQL} from '@octokit/graphql/dist-types/types'
+
 import Octokit from '@octokit/rest'
 import * as Context from './context'
 
@@ -9,14 +15,12 @@ Octokit.prototype = new Octokit()
 export const context = new Context.Context()
 
 export class GitHub extends Octokit {
-  graphql: (
-    query: string,
-    variables?: Variables
-  ) => Promise<GraphQlQueryResponse>
+  graphql: GraphQL
 
   constructor(token: string, opts: Omit<Octokit.Options, 'auth'> = {}) {
     super({...opts, auth: `token ${token}`})
-    this.graphql = defaults({
+
+    this.graphql = graphql.defaults({
       headers: {authorization: `token ${token}`}
     })
   }