From c53c6f1ec05af4c49705d437bee07c78c76353cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20B=C3=BCschel?= Date: Tue, 18 Apr 2023 00:35:24 +0800 Subject: [PATCH 1/3] feat: allow git commit type to be changed in configuration --- lib/add-contributor.js | 6 +++--- lib/modules/config.js | 5 +++++ test/unit/config.test.js | 17 +++++++++++++---- 3 files changed, 21 insertions(+), 7 deletions(-) diff --git a/lib/add-contributor.js b/lib/add-contributor.js index 451b8c82..053567be 100644 --- a/lib/add-contributor.js +++ b/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; diff --git a/lib/modules/config.js b/lib/modules/config.js index 95473ed1..9bce2af5 100644 --- a/lib/modules/config.js +++ b/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"; } diff --git a/test/unit/config.test.js b/test/unit/config.test.js index 16bbcfb7..5897484c 100644 --- a/test/unit/config.test.js +++ b/test/unit/config.test.js @@ -3,9 +3,10 @@ const Config = require("../../lib/modules/config.js"); describe("Config", () => { test("ensure default options", async () => { const config = new Config(); - + expect(config.options.files).toStrictEqual(["README.md"]); expect(config.options.contributorsPerLine).toStrictEqual(7); + expect(config.options.commitType).toStrictEqual("docs"); expect(config.options.commitConvention).toStrictEqual("angular"); expect(config.options.skipCi).toStrictEqual(true); expect(config.options.imageSize).toStrictEqual(100); @@ -16,9 +17,10 @@ describe("Config", () => { test("ensure fallback values for options", async () => { const config = new Config(null, {}); config.get() - + expect(config.options.files).toStrictEqual(["README.md"]); expect(config.options.contributorsPerLine).toStrictEqual(7); + expect(config.options.commitType).toStrictEqual("docs"); expect(config.options.commitConvention).toStrictEqual("angular"); expect(config.options.skipCi).toStrictEqual(true); expect(config.options.imageSize).toStrictEqual(100); @@ -33,13 +35,20 @@ describe("Config", () => { expect(config.options.files).toStrictEqual(["README.md"]); }); + test("invalid value for `commitType` option", async () => { + const config = new Config(null, { commitType: null }); + config.get() + + expect(config.options.commitType).toStrictEqual("docs"); + }); + test("invalid value for `commitConvention` option", async () => { const config = new Config(null, { commitConvention: null }); config.get() expect(config.options.commitConvention).toStrictEqual("angular"); }); - + test("invalid value for `contributorsPerLine` option", async () => { const config = new Config(null, { contributorsPerLine: "7" }); config.get() @@ -52,5 +61,5 @@ describe("Config", () => { config.get() expect(config.options.contributors).toStrictEqual([]); - }); + }); }); From bd49ed2f13de61b070557b9d6894227c8ab4e894 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20B=C3=BCschel?= Date: Sat, 20 May 2023 22:06:52 +0800 Subject: [PATCH 2/3] test: fix add-contributor commitType test and update snapshots --- lib/add-contributor.js | 2 +- .../__snapshots__/issue_comment.test.js.snap | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/add-contributor.js b/lib/add-contributor.js index 053567be..0c0dc233 100644 --- a/lib/add-contributor.js +++ b/lib/add-contributor.js @@ -78,7 +78,7 @@ async function addContributor({ body: prBody, filesByPath: filesByPathToUpdate, branchName, - convention, + convention: commitConvention, }); // let user know in comment diff --git a/test/integration/__snapshots__/issue_comment.test.js.snap b/test/integration/__snapshots__/issue_comment.test.js.snap index ce9540cf..39d0f181 100644 --- a/test/integration/__snapshots__/issue_comment.test.js.snap +++ b/test/integration/__snapshots__/issue_comment.test.js.snap @@ -420,7 +420,7 @@ Object { exports[`issue_comment event Happy path, add correct new contributor, but branch exists and PR is open: request body 2`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRUeXBlIjogImRvY3MiLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -489,7 +489,7 @@ Object { exports[`issue_comment event Happy path, add correct new contributor, but branch exists: request body 2`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRUeXBlIjogImRvY3MiLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -565,7 +565,7 @@ Object { exports[`issue_comment event Happy path, add correct new contributor, no allcontributors file (repo needs init first): request body 3`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJmaWxlcyI6IFsKICAgICJSRUFETUUubWQiCiAgXSwKICAiaW1hZ2VTaXplIjogMTAwLAogICJjb21taXQiOiBmYWxzZSwKICAiY29tbWl0Q29udmVudGlvbiI6ICJhbmd1bGFyIiwKICAiY29udHJpYnV0b3JzIjogWwogICAgewogICAgICAibG9naW4iOiAiamFrZWJvbGFtIiwKICAgICAgIm5hbWUiOiAiSmFrZSBCb2xhbSIsCiAgICAgICJhdmF0YXJfdXJsIjogImh0dHBzOi8vYXZhdGFyczIuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzUzNDIzNj92PTQiLAogICAgICAicHJvZmlsZSI6ICJodHRwczovL2pha2Vib2xhbS5jb20iLAogICAgICAiY29udHJpYnV0aW9ucyI6IFsKICAgICAgICAiY29kZSIsCiAgICAgICAgImRvYyIsCiAgICAgICAgImluZnJhIgogICAgICBdCiAgICB9CiAgXSwKICAiY29udHJpYnV0b3JzUGVyTGluZSI6IDcsCiAgInNraXBDaSI6IHRydWUsCiAgInJlcG9UeXBlIjogImdpdGh1YiIsCiAgInJlcG9Ib3N0IjogImh0dHBzOi8vZ2l0aHViLmNvbSIsCiAgInByb2plY3ROYW1lIjogImFsbC1jb250cmlidXRvcnMtYm90IiwKICAicHJvamVjdE93bmVyIjogImFsbC1jb250cmlidXRvcnMiCn0K", + "content": "ewogICJmaWxlcyI6IFsKICAgICJSRUFETUUubWQiCiAgXSwKICAiaW1hZ2VTaXplIjogMTAwLAogICJjb21taXQiOiBmYWxzZSwKICAiY29tbWl0VHlwZSI6ICJkb2NzIiwKICAiY29tbWl0Q29udmVudGlvbiI6ICJhbmd1bGFyIiwKICAiY29udHJpYnV0b3JzIjogWwogICAgewogICAgICAibG9naW4iOiAiamFrZWJvbGFtIiwKICAgICAgIm5hbWUiOiAiSmFrZSBCb2xhbSIsCiAgICAgICJhdmF0YXJfdXJsIjogImh0dHBzOi8vYXZhdGFyczIuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3UvMzUzNDIzNj92PTQiLAogICAgICAicHJvZmlsZSI6ICJodHRwczovL2pha2Vib2xhbS5jb20iLAogICAgICAiY29udHJpYnV0aW9ucyI6IFsKICAgICAgICAiY29kZSIsCiAgICAgICAgImRvYyIsCiAgICAgICAgImluZnJhIgogICAgICBdCiAgICB9CiAgXSwKICAiY29udHJpYnV0b3JzUGVyTGluZSI6IDcsCiAgInNraXBDaSI6IHRydWUsCiAgInJlcG9UeXBlIjogImdpdGh1YiIsCiAgInJlcG9Ib3N0IjogImh0dHBzOi8vZ2l0aHViLmNvbSIsCiAgInByb2plY3ROYW1lIjogImFsbC1jb250cmlidXRvcnMtYm90IiwKICAicHJvamVjdE93bmVyIjogImFsbC1jb250cmlidXRvcnMiCn0K", "message": "docs: create .all-contributorsrc [skip ci]", } `; @@ -642,7 +642,7 @@ Object { exports[`issue_comment event Happy path, add correct new contributor: request body 3`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRUeXBlIjogImRvY3MiLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -743,7 +743,7 @@ Object { exports[`issue_comment event Happy path, add correct new multiple contributors: request body 3`] = ` Object { "branch": "all-contributors/add-tenshiamd", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiCiAgICAgIF0KICAgIH0sCiAgICB7CiAgICAgICJsb2dpbiI6ICJ0ZW5zaGlhbWQiLAogICAgICAibmFtZSI6ICJBbmdlbCBBdmllbCBEb21hb2FuIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1YnVzZXJjb250ZW50LmNvbS91LzEzNTgwMzM4P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vdGVuc2hpYW1kLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiZG9jIiwKICAgICAgICAiaW5mcmEiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiCiAgICAgIF0KICAgIH0sCiAgICB7CiAgICAgICJsb2dpbiI6ICJ0ZW5zaGlhbWQiLAogICAgICAibmFtZSI6ICJBbmdlbCBBdmllbCBEb21hb2FuIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzLmdpdGh1YnVzZXJjb250ZW50LmNvbS91LzEzNTgwMzM4P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vdGVuc2hpYW1kLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiZG9jIiwKICAgICAgICAiaW5mcmEiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRUeXBlIjogImRvY3MiLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -780,7 +780,7 @@ Object { exports[`issue_comment event Happy path, add correct new multiple contributors: request body 7`] = ` Object { "branch": "all-contributors/add-gr2m", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiCiAgICAgIF0KICAgIH0sCiAgICB7CiAgICAgICJsb2dpbiI6ICJncjJtIiwKICAgICAgIm5hbWUiOiAiZ3IybSIsCiAgICAgICJhdmF0YXJfdXJsIjogImh0dHBzOi8vYXZhdGFycy5naXRodWJ1c2VyY29udGVudC5jb20vdS82MDE3OTE3OT92PTQiLAogICAgICAicHJvZmlsZSI6ICJodHRwczovL2dpdGh1Yi5jb20vZ3IybSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJkZXNpZ24iLAogICAgICAgICJ0ZXN0IgogICAgICBdCiAgICB9CiAgXSwKICAiY29tbWl0Q29udmVudGlvbiI6ICJhbmd1bGFyIiwKICAiY29udHJpYnV0b3JzUGVyTGluZSI6IDcKfQo=", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiCiAgICAgIF0KICAgIH0sCiAgICB7CiAgICAgICJsb2dpbiI6ICJncjJtIiwKICAgICAgIm5hbWUiOiAiZ3IybSIsCiAgICAgICJhdmF0YXJfdXJsIjogImh0dHBzOi8vYXZhdGFycy5naXRodWJ1c2VyY29udGVudC5jb20vdS82MDE3OTE3OT92PTQiLAogICAgICAicHJvZmlsZSI6ICJodHRwczovL2dpdGh1Yi5jb20vZ3IybSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJkZXNpZ24iLAogICAgICAgICJ0ZXN0IgogICAgICBdCiAgICB9CiAgXSwKICAiY29tbWl0VHlwZSI6ICJkb2NzIiwKICAiY29tbWl0Q29udmVudGlvbiI6ICJhbmd1bGFyIiwKICAiY29udHJpYnV0b3JzUGVyTGluZSI6IDcKfQo=", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -890,7 +890,7 @@ Object { exports[`issue_comment event User has no name and blog: request body 3`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgInNraXBDaSI6IGZhbHNlLAogICJjb250cmlidXRvcnMiOiBbCiAgICB7CiAgICAgICJsb2dpbiI6ICJqYWtlYm9sYW0iLAogICAgICAibmFtZSI6ICJKYWtlIEJvbGFtIiwKICAgICAgImF2YXRhcl91cmwiOiAiaHR0cHM6Ly9hdmF0YXJzMi5naXRodWJ1c2VyY29udGVudC5jb20vdS8zNTM0MjM2P3Y9NCIsCiAgICAgICJwcm9maWxlIjogImh0dHBzOi8vamFrZWJvbGFtLmNvbSIsCiAgICAgICJjb250cmlidXRpb25zIjogWwogICAgICAgICJjb2RlIiwKICAgICAgICAiaWRlYXMiLAogICAgICAgICJpbmZyYSIsCiAgICAgICAgInRlc3QiLAogICAgICAgICJkb2MiCiAgICAgIF0KICAgIH0KICBdLAogICJjb21taXRUeXBlIjogImRvY3MiLAogICJjb21taXRDb252ZW50aW9uIjogImFuZ3VsYXIiLAogICJjb250cmlidXRvcnNQZXJMaW5lIjogNwp9Cg==", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } @@ -987,7 +987,7 @@ Object { exports[`issue_comment event skipCi=false: request body 3`] = ` Object { "branch": "all-contributors/add-jakebolam", - "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgImNvbnRyaWJ1dG9ycyI6IFsKICAgIHsKICAgICAgImxvZ2luIjogImpha2Vib2xhbSIsCiAgICAgICJuYW1lIjogIkpha2UgQm9sYW0iLAogICAgICAiYXZhdGFyX3VybCI6ICJodHRwczovL2F2YXRhcnMyLmdpdGh1YnVzZXJjb250ZW50LmNvbS91LzM1MzQyMzY/dj00IiwKICAgICAgInByb2ZpbGUiOiAiaHR0cHM6Ly9qYWtlYm9sYW0uY29tIiwKICAgICAgImNvbnRyaWJ1dGlvbnMiOiBbCiAgICAgICAgImNvZGUiLAogICAgICAgICJpZGVhcyIsCiAgICAgICAgImluZnJhIiwKICAgICAgICAidGVzdCIsCiAgICAgICAgImRvYyIKICAgICAgXQogICAgfQogIF0sCiAgImNvbW1pdENvbnZlbnRpb24iOiAiYW5ndWxhciIsCiAgImNvbnRyaWJ1dG9yc1BlckxpbmUiOiA3Cn0K", + "content": "ewogICJwcm9qZWN0TmFtZSI6ICJhbGwtY29udHJpYnV0b3JzLWJvdCIsCiAgInByb2plY3RPd25lciI6ICJhbGwtY29udHJpYnV0b3JzIiwKICAicmVwb1R5cGUiOiAiZ2l0aHViIiwKICAicmVwb0hvc3QiOiAiaHR0cHM6Ly9naXRodWIuY29tIiwKICAiZmlsZXMiOiBbCiAgICAiUkVBRE1FLm1kIgogIF0sCiAgImltYWdlU2l6ZSI6IDEwMCwKICAiY29tbWl0IjogZmFsc2UsCiAgImNvbnRyaWJ1dG9ycyI6IFsKICAgIHsKICAgICAgImxvZ2luIjogImpha2Vib2xhbSIsCiAgICAgICJuYW1lIjogIkpha2UgQm9sYW0iLAogICAgICAiYXZhdGFyX3VybCI6ICJodHRwczovL2F2YXRhcnMyLmdpdGh1YnVzZXJjb250ZW50LmNvbS91LzM1MzQyMzY/dj00IiwKICAgICAgInByb2ZpbGUiOiAiaHR0cHM6Ly9qYWtlYm9sYW0uY29tIiwKICAgICAgImNvbnRyaWJ1dGlvbnMiOiBbCiAgICAgICAgImNvZGUiLAogICAgICAgICJpZGVhcyIsCiAgICAgICAgImluZnJhIiwKICAgICAgICAidGVzdCIsCiAgICAgICAgImRvYyIKICAgICAgXQogICAgfQogIF0sCiAgImNvbW1pdFR5cGUiOiAiZG9jcyIsCiAgImNvbW1pdENvbnZlbnRpb24iOiAiYW5ndWxhciIsCiAgImNvbnRyaWJ1dG9yc1BlckxpbmUiOiA3Cn0K", "message": "docs: update .all-contributorsrc", "sha": "dff34f715bca51114c0336a49381456a926806d5", } From ba0aab7c12ad76cfdbe8be7429313fe3b0721d88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20B=C3=BCschel?= Date: Sun, 21 May 2023 11:49:46 +0800 Subject: [PATCH 3/3] fix: ensure commit type is also applied to actual commits --- lib/add-contributor.js | 1 + lib/modules/repository.js | 17 +++++++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/lib/add-contributor.js b/lib/add-contributor.js index 0c0dc233..642a8b1e 100644 --- a/lib/add-contributor.js +++ b/lib/add-contributor.js @@ -79,6 +79,7 @@ async function addContributor({ filesByPath: filesByPathToUpdate, branchName, convention: commitConvention, + commitType, }); // let user know in comment diff --git a/lib/modules/repository.js b/lib/modules/repository.js index 1c8c9a81..8071b2d3 100644 --- a/lib/modules/repository.js +++ b/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,9 +161,10 @@ 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, @@ -171,11 +172,12 @@ class Repository { 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({