github - npm Package Compare versions

Comparing version 9.3.1 to 10.0.0

CHANGELOG.md

 # CHANGELOG
 
+## 10.0.0
+
+Breaking changes:
+  * getCombinedStatus -> getCombinedStatusForRef.
+  * Specify deploy key in deploy key related methods.
+  * Chanage createDeployKey to addDeployKey.
+  * Remove deprecated line param from createCommitComment.
+  * Remove deprecated line param from the create commit comment endpoint.
+
+Features:
+  * Add get-gpg-keys-for-user endpoint.
+  * Add endpoint to toggle user primary email visibility.
+  * Add endpoint to get user's public emails.
+  * Allow to do commit signature verification.
+  * Add repo topic-related endpoints.
+
+Bug fixes:
+  * Fix removeAssigneesFromIssue endpoint.
+  * Fix params for addLabelsToIssue example.
+  * Add author param to file-related endpoints.
+  * Add author param to create file endpoint.
+  * Update typings generator.
+  * Fix missing TypeScript interface generics.
+  * Update community profile metrics endpoint.
+  * Add require_code_owner_reviews param to endpoint.
+  * Add require_code_owner_reviews param to Update branch protection
+    endpoint.
+  * Clean up params of Update branch required status checks.
+
 ## 9.3.1
@@ -4,0 +33,0 @@

examples/addLabelsToIssue.js

@@ -19,5 +19,5 @@ "use strict";
     number: "4",
-    body: ["bug", "help wanted", "question"]
+    labels: ["bug", "help wanted", "question"]
 }, function(err, res) {
     console.log(err, res);
 });

lib/generate.js

@@ -189,2 +189,5 @@ #!/usr/bin/env node
 
+    // XXX: Doc generation is a little manual due to some customizations with
+    //      JSON APIs so leave commented out and uncomment when generating new
+    //      docs.
     // var apidocsPath = Path.join(__dirname, "/../doc", "apidoc.js");
@@ -191,0 +194,0 @@ // fs.writeFileSync(apidocsPath, apidocs);

lib/generateTypes.js

@@ -44,2 +44,3 @@ #!/usr/bin/env node
         case "reviewers":
+        case "team_reviewers":
         case "comments":
@@ -49,2 +50,3 @@ case "labels":
         case "users":
+        case "names":
         case "emails":
@@ -164,3 +166,3 @@ if (type === "Array") {
     }, []);
- 
+
     var body = Mustache.render(template, {
@@ -167,0 +169,0 @@ requestHeaders: requestHeaders.map(JSON.stringify),

package.json

 {
   "name": "github",
-  "version": "9.3.1",
+  "version": "10.0.0",
   "description": "NodeJS wrapper for the GitHub API",
@@ -53,3 +53,3 @@ "author": "Mike de Boer <[e-mail]>",
     "name": "node-github",
-    "version": "9.3.1",
+    "version": "10.0.0",
     "template": {
@@ -56,0 +56,0 @@ "withCompare": true

README.md

@@ -218,2 +218,3 @@ # Node-github
 | Timeline                | application/vnd.github.mockingbird-preview            |
+| Topics                  | application/vnd.github.mercy-preview+json             |
 
@@ -220,0 +221,0 @@ ## Dev notes

test/issuesTest.js

@@ -591,3 +591,3 @@ /*
                 number: "Number",
-                assignees: "Array"
+                body: "Json"
             },
@@ -594,0 +594,0 @@ function(err, res) {

test/reposTest.js

@@ -44,2 +44,19 @@ /*
 
+    it("should successfully execute POST /repos/:owner/:repo/keys (addDeployKey)",  function(next) {
+        client.repos.addDeployKey(
+            {
+                owner: "String",
+                repo: "String",
+                title: "String",
+                key: "String",
+                read_only: "Boolean"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins (addProtectedBranchAdminEnforcement)",  function(next) {
@@ -175,4 +192,3 @@ client.repos.addProtectedBranchAdminEnforcement(
                 path: "String",
-                position: "Number",
-                line: "Number"
+                position: "Number"
             },
@@ -240,3 +256,4 @@ function(err, res) {
                 branch: "String",
-                committer: "Json"
+                committer: "Json",
+                author: "Json"
             },
@@ -296,19 +313,2 @@ function(err, res) {
 
-    it("should successfully execute POST /repos/:owner/:repo/keys (createKey)",  function(next) {
-        client.repos.createKey(
-            {
-                owner: "String",
-                repo: "String",
-                title: "String",
-                key: "String",
-                read_only: "Boolean"
-            },
-            function(err, res) {
-                Assert.equal(err, null);
-                // other assertions go here
-                next();
-            }
-        );
-    });
-
     it("should successfully execute POST /repos/:owner/:repo/releases (createRelease)",  function(next) {
@@ -397,2 +397,17 @@ client.repos.createRelease(
 
+    it("should successfully execute DELETE /repos/:owner/:repo/keys/:id (deleteDeployKey)",  function(next) {
+        client.repos.deleteDeployKey(
+            {
+                owner: "String",
+                repo: "String",
+                id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute DELETE /repos/:owner/:repo/downloads/:id (deleteDownload)",  function(next) {
@@ -422,3 +437,4 @@ client.repos.deleteDownload(
                 branch: "String",
-                committer: "Json"
+                committer: "Json",
+                author: "Json"
             },
@@ -463,17 +479,2 @@ function(err, res) {
 
-    it("should successfully execute DELETE /repos/:owner/:repo/keys/:id (deleteKey)",  function(next) {
-        client.repos.deleteKey(
-            {
-                owner: "String",
-                repo: "String",
-                id: "String"
-            },
-            function(err, res) {
-                Assert.equal(err, null);
-                // other assertions go here
-                next();
-            }
-        );
-    });
-
     it("should successfully execute DELETE /repos/:owner/:repo/releases/:id (deleteRelease)",  function(next) {
@@ -785,4 +786,4 @@ client.repos.deleteRelease(
 
-    it("should successfully execute GET /repos/:owner/:repo/commits/:ref/status (getCombinedStatus)",  function(next) {
-        client.repos.getCombinedStatus(
+    it("should successfully execute GET /repos/:owner/:repo/commits/:ref/status (getCombinedStatusForRef)",  function(next) {
+        client.repos.getCombinedStatusForRef(
             {
@@ -871,6 +872,7 @@ owner: "String",
 
-    it("should successfully execute GET /repositories/:repo_id/community/profile (getCommunityHealthMetrics)",  function(next) {
-        client.repos.getCommunityHealthMetrics(
+    it("should successfully execute GET /repos/:owner/:name/community/profile (getCommunityProfileMetrics)",  function(next) {
+        client.repos.getCommunityProfileMetrics(
             {
-                repo_id: "String"
+                owner: "String",
+                name: "String"
             },
@@ -918,2 +920,64 @@ function(err, res) {
 
+    it("should successfully execute GET /repos/:owner/:repo/keys/:id (getDeployKey)",  function(next) {
+        client.repos.getDeployKey(
+            {
+                owner: "String",
+                repo: "String",
+                id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
+    it("should successfully execute GET /repos/:owner/:repo/keys (getDeployKeys)",  function(next) {
+        client.repos.getDeployKeys(
+            {
+                owner: "String",
+                repo: "String",
+                page: "Number",
+                per_page: "Number"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
+    it("should successfully execute GET /repos/:owner/:repo/deployments/:deployment_id (getDeployment)",  function(next) {
+        client.repos.getDeployment(
+            {
+                owner: "String",
+                repo: "String",
+                deployment_id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
+    it("should successfully execute GET /repos/:owner/:repo/deployments/:id/statuses/:status_id (getDeploymentStatus)",  function(next) {
+        client.repos.getDeploymentStatus(
+            {
+                owner: "String",
+                repo: "String",
+                id: "String",
+                status_id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /repos/:owner/:repo/deployments/:id/statuses (getDeploymentStatuses)",  function(next) {
@@ -1081,33 +1145,2 @@ client.repos.getDeploymentStatuses(
 
-    it("should successfully execute GET /repos/:owner/:repo/keys/:id (getKey)",  function(next) {
-        client.repos.getKey(
-            {
-                owner: "String",
-                repo: "String",
-                id: "String"
-            },
-            function(err, res) {
-                Assert.equal(err, null);
-                // other assertions go here
-                next();
-            }
-        );
-    });
-
-    it("should successfully execute GET /repos/:owner/:repo/keys (getKeys)",  function(next) {
-        client.repos.getKeys(
-            {
-                owner: "String",
-                repo: "String",
-                page: "Number",
-                per_page: "Number"
-            },
-            function(err, res) {
-                Assert.equal(err, null);
-                // other assertions go here
-                next();
-            }
-        );
-    });
-
     it("should successfully execute GET /repos/:owner/:repo/languages (getLanguages)",  function(next) {
@@ -1342,3 +1375,5 @@ client.repos.getLanguages(
             {
-                since: "String"
+                since: "String",
+                page: "Number",
+                per_page: "Number"
             },
@@ -1564,2 +1599,18 @@ function(err, res) {
 
+    it("should successfully execute GET /repos/:owner/:repo/topics (getTopics)",  function(next) {
+        client.repos.getTopics(
+            {
+                owner: "String",
+                repo: "String",
+                page: "Number",
+                per_page: "Number"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /repos/:owner/:repo/traffic/views (getViews)",  function(next) {
@@ -1682,5 +1733,3 @@ client.repos.getViews(
                 repo: "String",
-                branch: "String",
-                page: "Number",
-                per_page: "Number"
+                branch: "String"
             },
@@ -1806,2 +1855,17 @@ function(err, res) {
 
+    it("should successfully execute PUT /repos/:owner/:repo/topics (replaceTopics)",  function(next) {
+        client.repos.replaceTopics(
+            {
+                owner: "String",
+                repo: "String",
+                names: "Array"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute POST /repos/:owner/:repo/pages/builds (requestPageBuild)",  function(next) {
@@ -1899,3 +1963,4 @@ client.repos.requestPageBuild(
                 branch: "String",
-                committer: "Json"
+                committer: "Json",
+                author: "Json"
             },
@@ -1933,3 +1998,4 @@ function(err, res) {
                 dismissal_restrictions: "Json",
-                dismiss_stale_reviews: "Boolean"
+                dismiss_stale_reviews: "Boolean",
+                require_code_owner_reviews: "Boolean"
             },
@@ -1950,7 +2016,4 @@ function(err, res) {
                 branch: "String",
-                include_admins: "Boolean",
                 strict: "Boolean",
-                contexts: "Array",
-                page: "Number",
-                per_page: "Number"
+                contexts: "Array"
             },
@@ -1957,0 +2020,0 @@ function(err, res) {

test/usersTest.js

@@ -386,2 +386,17 @@ /*
 
+    it("should successfully execute GET /users/:username/gpg_keys (getGpgKeysForUser)",  function(next) {
+        client.users.getGpgKeysForUser(
+            {
+                username: "String",
+                page: "Number",
+                per_page: "Number"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /user/keys/:id (getKey)",  function(next) {
@@ -469,2 +484,16 @@ client.users.getKey(
 
+    it("should successfully execute GET /user/public_emails (getPublicEmails)",  function(next) {
+        client.users.getPublicEmails(
+            {
+                page: "Number",
+                per_page: "Number"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /user/repository_invitations (getRepoInvites)",  function(next) {
@@ -521,2 +550,13 @@ client.users.getRepoInvites(
 
+    it("should successfully execute PATCH /user/email/visibility (togglePrimaryEmailVisibility)",  function(next) {
+        client.users.togglePrimaryEmailVisibility(
+            {},
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute DELETE /user/blocks/:username (unblockUser)",  function(next) {
@@ -523,0 +563,0 @@ client.users.unblockUser(

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2136138

increased by11.21%

Lines of code

58079

increased by11.9%

Number of lines in readme file

240

increased by0.42%

No dependency changes