v3.0.0: Allow multiple commits in a single request

Allow multiple commits

Author: mheap

README.md

@@ -10,11 +10,11 @@ npm install octokit-commit-multiple-files --save
 
 ## Usage
 
-This plugin accepts `owner`, `repo`, `path`, `branch` and `message` like `.createOrUpdateFile` ([Octokit Docs](https://octokit.github.io/rest.js/#octokit-routes-repos-create-or-update-file)).
+This plugin accepts `owner`, `repo`, `path` and `branch` like `.createOrUpdateFile` ([Octokit Docs](https://octokit.github.io/rest.js/#octokit-routes-repos-create-or-update-file)).
 
 If the `branch` provided does not exist, the plugin will error. To automatically create it, set `createBranch` to true. You may provide a `base` branch if you choose to do this, or the plugin will use the repo's default branch as the base.
 
-In addition, it accepts `changes` which is an array of objects containing a `path` and the file `contents`.
+In addition, it accepts `changes` which is an array of objects containing a `message` and a `files` object
 
 ```javascript
 const Octokit = require("@octokit/rest").plugin(
@@ -27,17 +27,39 @@ const branchName = await octokit.repos.createOrUpdateFiles({
   repo,
   branch,
   createBranch,
-  message,
   changes: [
     {
-      path: "test.md",
-      contents: "One"
+      message: "Your commit message",
+      files: {
+        "test.md": `# This is a test
+
+I hope it works`,
+        "test2.md": {
+          contents: `Something else`
+        }
+      }
     },
     {
-      path: "test2.md",
-      contents: "Two"
+      "message": "This is a separate commit",
+      "files": {
+        "second.md": "Where should we go today?"
+      }
     }
   ]
 })
 ```
 
+In addition, you can set the `mode` of a file change. For example, if you wanted to update a submodule pointer:
+
+```javascript
+{
+  "message": "This is a submodule commit",
+  "files": {
+    "my_submodule": {
+      "contents": "your-commit-sha",
+      "mode": "160000",
+      "type": "commit"
+    }
+  }
+}
+```

create-or-update-files.js

@@ -2,7 +2,7 @@ module.exports = function(octokit, opts) {
   return new Promise(async (resolve, reject) => {
     // Up front validation
     try {
-      for (let req of ["owner", "repo", "branch", "message"]) {
+      for (let req of ["owner", "repo", "branch"]) {
         if (!opts[req]) {
           return reject(`'${req}' is a required parameter`);
         }
@@ -19,8 +19,7 @@ module.exports = function(octokit, opts) {
         base,
         branch: branchName,
         createBranch,
-        changes,
-        message
+        changes
       } = opts;
 
       let branchAlreadyExists = true;
@@ -57,60 +56,74 @@ module.exports = function(octokit, opts) {
       }
 
       // Create blobs
-      const treeItems = [];
       for (let change of changes) {
-        if (!change.contents) {
-          return reject(
-            `No file contents provided for ${change.path || "Un-named file"}`
-          );
+        let message = change.message;
+        if (!message) {
+          return reject(`changes[].message is a required parameter`);
+        }
+        if (!change.files || Object.keys(change.files).length === 0) {
+          return reject(`changes[].files is a required parameter`);
         }
 
-        if (!change.path) {
-          return reject(
-            `No file path provided for the following contents: ${change.contents.substr(
-              0,
-              30
-            )}...`
-          );
+        const treeItems = [];
+        for (let fileName in change.files) {
+          let properties = change.files[fileName] || "";
+
+          let contents = properties.contents || properties;
+          let mode = properties.mode || "100644";
+          let type = properties.type || "blob";
+
+          if (!contents) {
+            return reject(`No file contents provided for ${fileName}`);
+          }
+
+          let fileSha;
+          if (type == "commit") {
+            fileSha = contents;
+          } else {
+            let file = (
+              await octokit.git.createBlob({
+                owner,
+                repo,
+                content: Buffer.from(contents).toString("base64"),
+                encoding: "base64"
+              })
+            ).data;
+            fileSha = file.sha;
+          }
+
+          treeItems.push({
+            path: fileName,
+            sha: fileSha,
+            mode: mode,
+            type: type
+          });
         }
 
-        let file = (
-          await octokit.git.createBlob({
+        // Add those blobs to a tree
+        let tree = (
+          await octokit.git.createTree({
             owner,
             repo,
-            content: Buffer.from(change.contents).toString("base64"),
-            encoding: "base64"
+            tree: treeItems,
+            base_tree: baseTree
           })
         ).data;
 
-        treeItems.push({
-          path: change.path,
-          sha: file.sha,
-          mode: "100644",
-          type: "blob"
-        });
-      }
-
-      // Add those blobs to a tree
-      let tree = (
-        await octokit.git.createTree({
-          owner,
-          repo,
-          tree: treeItems,
-          base_tree: baseTree
-        })
-      ).data;
+        // Create a commit that points to that tree
+        let commit = (
+          await octokit.git.createCommit({
+            owner,
+            repo,
+            message,
+            tree: tree.sha,
+            parents: [baseTree]
+          })
+        ).data;
 
-      // Create a commit that points to that tree
-      let commit = (
-        await octokit.git.createCommit({
-          owner,
-          repo,
-          message,
-          tree: tree.sha,
-          parents: [baseTree]
-        })
-      ).data;
+        // Update the base tree if we have another commit to make
+        baseTree = commit.sha;
+      }
 
       // Create a ref that points to that tree
       let action = "createRef";
@@ -128,7 +141,7 @@ module.exports = function(octokit, opts) {
           repo,
           force: true,
           ref: `${updateRefBase}heads/${branchName}`,
-          sha: commit.sha
+          sha: baseTree
         })
       ).data;