feat: allow git commit type to be changed in configuration (#462)

Author: tobiasbueschel

lib/add-contributor.js

@@ -55,11 +55,11 @@ async function addContributor({
     originalSha: config.getOriginalSha(),
   };
 
-  const convention = config.get().commitConvention;
+  const { commitConvention, commitType } = config.get();
   const prTitle = convertMessage({
-    tag: "docs",
+    tag: commitType,
     msg: generatePrTitle(`add ${who} as a contributor`, contributions),
-    convention
+    convention: commitConvention
   });
 
   const skipCi = config.get().skipCi;
@@ -78,7 +78,8 @@ async function addContributor({
     body: prBody,
     filesByPath: filesByPathToUpdate,
     branchName,
-    convention,
+    convention: commitConvention,
+    commitType,
   });
 
   // let user know in comment

lib/modules/config.js

@@ -12,6 +12,7 @@ class Config {
       files: ["README.md"],
       imageSize: 100,
       commit: false,
+      commitType: "docs",
       commitConvention: "angular",
       contributors: [],
       contributorsPerLine: 7,
@@ -69,6 +70,10 @@ class Config {
       options.files = ["README.md"];
     }
 
+    if (!options.commitType) {
+      options.commitType = "docs";
+    }
+
     if (!options.commitConvention) {
       options.commitConvention = "angular";
     }

lib/modules/repository.js

@@ -118,7 +118,7 @@ class Repository {
     });
   }
 
-  async updateFile({ filePath, content, branchName, originalSha, convention }) {
+  async updateFile({ filePath, content, branchName, originalSha, convention, commitType }) {
     const contentBinary = Buffer.from(content).toString("base64");
 
     //octokit.github.io/rest.js/#api-Repos-updateFile
@@ -127,7 +127,7 @@ class Repository {
       repo: this.repo,
       path: filePath,
       message: convertMessage({
-        tag: "docs",
+        tag: commitType,
         msg: `update ${filePath} ${this.skipCiString}`,
         convention,
       }).trim(),
@@ -137,7 +137,7 @@ class Repository {
     });
   }
 
-  async createFile({ filePath, content, branchName, convention }) {
+  async createFile({ filePath, content, branchName, convention, commitType }) {
     const contentBinary = Buffer.from(content).toString("base64");
 
     //octokit.github.io/rest.js/#api-Repos-createFile
@@ -146,7 +146,7 @@ class Repository {
       repo: this.repo,
       path: filePath,
       message: convertMessage({
-        tag: "docs",
+        tag: commitType,
         msg: `create ${filePath} ${this.skipCiString}`,
         convention,
       }).trim(),
@@ -161,21 +161,23 @@ class Repository {
     branchName,
     originalSha,
     convention,
+    commitType,
   }) {
     if (originalSha === undefined) {
-      await this.createFile({ filePath, content, branchName, convention });
+      await this.createFile({ filePath, content, branchName, convention, commitType });
     } else {
       await this.updateFile({
         filePath,
         content,
         branchName,
         originalSha,
         convention,
+        commitType,
       });
     }
   }
 
-  async createOrUpdateFiles({ filesByPath, branchName, convention }) {
+  async createOrUpdateFiles({ filesByPath, branchName, convention, commitType }) {
     const repository = this;
     const createOrUpdateFilesMultiple = Object.entries(filesByPath).map(
       ([filePath, { content, originalSha }]) => {
@@ -185,6 +187,7 @@ class Repository {
           branchName,
           originalSha,
           convention,
+          commitType,
         });
       }
     );
@@ -252,6 +255,7 @@ class Repository {
     filesByPath,
     branchName,
     convention,
+    commitType,
   }) {
     const branchNameExists = branchName === this.baseBranch;
     if (!branchNameExists) {
@@ -262,6 +266,7 @@ class Repository {
       filesByPath,
       branchName,
       convention,
+      commitType,
     });
 
     return this.createPullRequest({