From 3cd1f3c5cf51a6a9d83619b9b41c10f2257e2060 Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:07:22 +0000 Subject: [PATCH 1/3] fix: support submodules when commit signing --- __test__/create-or-update-branch.int.test.ts | 39 +++++++++++++------- __test__/git-command-manager.int.test.ts | 22 ++++++----- dist/index.js | 9 +++-- src/git-command-manager.ts | 10 +++-- 4 files changed, 48 insertions(+), 32 deletions(-) diff --git a/__test__/create-or-update-branch.int.test.ts b/__test__/create-or-update-branch.int.test.ts index 9303e54966..276b54b3c2 100644 --- a/__test__/create-or-update-branch.int.test.ts +++ b/__test__/create-or-update-branch.int.test.ts @@ -250,11 +250,15 @@ describe('create-or-update-branch tests', () => { expect(branchCommits.length).toEqual(1) expect(branchCommits[0].subject).toEqual('Test changes') expect(branchCommits[0].changes.length).toEqual(3) - expect(branchCommits[0].changes).toEqual([ - {mode: '100755', path: UNTRACKED_EXE_FILE, status: 'A'}, - {mode: '100644', path: TRACKED_FILE, status: 'M'}, - {mode: '100644', path: UNTRACKED_FILE, status: 'A'} - ]) + expect(branchCommits[0].changes[0].mode).toEqual('100755') + expect(branchCommits[0].changes[0].path).toEqual(UNTRACKED_EXE_FILE) + expect(branchCommits[0].changes[0].status).toEqual('A') + expect(branchCommits[0].changes[1].mode).toEqual('100644') + expect(branchCommits[0].changes[1].path).toEqual(TRACKED_FILE) + expect(branchCommits[0].changes[1].status).toEqual('M') + expect(branchCommits[0].changes[2].mode).toEqual('100644') + expect(branchCommits[0].changes[2].path).toEqual(UNTRACKED_FILE) + expect(branchCommits[0].changes[2].status).toEqual('A') }) it('tests buildBranchCommits with addition and deletion', async () => { @@ -272,11 +276,15 @@ describe('create-or-update-branch tests', () => { expect(branchCommits.length).toEqual(1) expect(branchCommits[0].subject).toEqual('Test changes') expect(branchCommits[0].changes.length).toEqual(3) - expect(branchCommits[0].changes).toEqual([ - {mode: '100644', path: TRACKED_FILE, status: 'D'}, - {mode: '100644', path: UNTRACKED_FILE, status: 'A'}, - {mode: '100644', path: TRACKED_FILE_NEW_PATH, status: 'A'} - ]) + expect(branchCommits[0].changes[0].mode).toEqual('100644') + expect(branchCommits[0].changes[0].path).toEqual(TRACKED_FILE) + expect(branchCommits[0].changes[0].status).toEqual('D') + expect(branchCommits[0].changes[1].mode).toEqual('100644') + expect(branchCommits[0].changes[1].path).toEqual(UNTRACKED_FILE) + expect(branchCommits[0].changes[1].status).toEqual('A') + expect(branchCommits[0].changes[2].mode).toEqual('100644') + expect(branchCommits[0].changes[2].path).toEqual(TRACKED_FILE_NEW_PATH) + expect(branchCommits[0].changes[2].status).toEqual('A') }) it('tests buildBranchCommits with multiple commits', async () => { @@ -294,10 +302,13 @@ describe('create-or-update-branch tests', () => { expect(branchCommits[i].subject).toEqual(`Test changes ${i}`) expect(branchCommits[i].changes.length).toEqual(2) const untrackedFileStatus = i == 0 ? 'A' : 'M' - expect(branchCommits[i].changes).toEqual([ - {mode: '100644', path: TRACKED_FILE, status: 'M'}, - {mode: '100644', path: UNTRACKED_FILE, status: untrackedFileStatus} - ]) + + expect(branchCommits[i].changes[0].mode).toEqual('100644') + expect(branchCommits[i].changes[0].path).toEqual(TRACKED_FILE) + expect(branchCommits[i].changes[0].status).toEqual('M') + expect(branchCommits[i].changes[1].mode).toEqual('100644') + expect(branchCommits[i].changes[1].path).toEqual(UNTRACKED_FILE) + expect(branchCommits[i].changes[1].status).toEqual(untrackedFileStatus) } }) diff --git a/__test__/git-command-manager.int.test.ts b/__test__/git-command-manager.int.test.ts index 33304a4425..415637c01b 100644 --- a/__test__/git-command-manager.int.test.ts +++ b/__test__/git-command-manager.int.test.ts @@ -18,9 +18,9 @@ describe('git-command-manager integration tests', () => { expect(initialCommit.subject).toEqual('initial commit') expect(initialCommit.signed).toBeFalsy() - expect(initialCommit.changes).toEqual([ - {mode: '100644', status: 'A', path: 'README_TEMP.md'} - ]) + expect(initialCommit.changes[0].mode).toEqual('100644') + expect(initialCommit.changes[0].status).toEqual('A') + expect(initialCommit.changes[0].path).toEqual('README_TEMP.md') expect(emptyCommit.subject).toEqual('empty commit for tests') expect(emptyCommit.tree).toEqual(initialCommit.tree) // empty commits have no tree and reference the parent's @@ -31,16 +31,18 @@ describe('git-command-manager integration tests', () => { expect(modifiedCommit.subject).toEqual('add sparkles') expect(modifiedCommit.parents[0]).toEqual(emptyCommit.sha) expect(modifiedCommit.signed).toBeFalsy() - expect(modifiedCommit.changes).toEqual([ - {mode: '100644', status: 'M', path: 'README_TEMP.md'} - ]) + expect(modifiedCommit.changes[0].mode).toEqual('100644') + expect(modifiedCommit.changes[0].status).toEqual('M') + expect(modifiedCommit.changes[0].path).toEqual('README_TEMP.md') expect(headCommit.subject).toEqual('rename readme') expect(headCommit.parents[0]).toEqual(modifiedCommit.sha) expect(headCommit.signed).toBeFalsy() - expect(headCommit.changes).toEqual([ - {mode: '100644', status: 'A', path: 'README.md'}, - {mode: '100644', status: 'D', path: 'README_TEMP.md'} - ]) + expect(headCommit.changes[0].mode).toEqual('100644') + expect(headCommit.changes[0].status).toEqual('A') + expect(headCommit.changes[0].path).toEqual('README.md') + expect(headCommit.changes[1].mode).toEqual('100644') + expect(headCommit.changes[1].status).toEqual('D') + expect(headCommit.changes[1].path).toEqual('README_TEMP.md') }) }) diff --git a/dist/index.js b/dist/index.js index f2b3a02a0f..1bda23f7b2 100644 --- a/dist/index.js +++ b/dist/index.js @@ -762,12 +762,13 @@ class GitCommandManager { subject: detailLines[4], body: detailLines.slice(5, endOfBodyIndex).join('\n'), changes: lines.slice(endOfBodyIndex + 2, -1).map(line => { - const change = line.match(/^:(\d{6}) (\d{6}) \w{40} \w{40} ([AMD])\s+(.*)$/); + const change = line.match(/^:(\d{6}) (\d{6}) \w{40} (\w{40}) ([AMD])\s+(.*)$/); if (change) { return { - mode: change[3] === 'D' ? change[1] : change[2], - status: change[3], - path: change[4] + mode: change[4] === 'D' ? change[1] : change[2], + dstSha: change[3], + status: change[4], + path: change[5] }; } else { diff --git a/src/git-command-manager.ts b/src/git-command-manager.ts index b17e1f3d05..7d60950fbd 100644 --- a/src/git-command-manager.ts +++ b/src/git-command-manager.ts @@ -14,6 +14,7 @@ export type Commit = { body: string changes: { mode: string + dstSha: string status: 'A' | 'M' | 'D' path: string }[] @@ -178,13 +179,14 @@ export class GitCommandManager { body: detailLines.slice(5, endOfBodyIndex).join('\n'), changes: lines.slice(endOfBodyIndex + 2, -1).map(line => { const change = line.match( - /^:(\d{6}) (\d{6}) \w{40} \w{40} ([AMD])\s+(.*)$/ + /^:(\d{6}) (\d{6}) \w{40} (\w{40}) ([AMD])\s+(.*)$/ ) if (change) { return { - mode: change[3] === 'D' ? change[1] : change[2], - status: change[3], - path: change[4] + mode: change[4] === 'D' ? change[1] : change[2], + dstSha: change[3], + status: change[4], + path: change[5] } } else { unparsedChanges.push(line) From 51d50085765a1428a810c368d17d35e60846e9ec Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:34:03 +0000 Subject: [PATCH 2/3] create correct tree object for submodule --- dist/index.js | 45 ++++++++++++++++++++------------- src/github-helper.ts | 60 ++++++++++++++++++++++++++------------------ 2 files changed, 63 insertions(+), 42 deletions(-) diff --git a/dist/index.js b/dist/index.js index 1bda23f7b2..4284a52680 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1369,25 +1369,36 @@ class GitHubHelper { let treeSha = parentCommit.tree; if (commit.changes.length > 0) { core.info(`Creating tree objects for local commit ${commit.sha}`); - const treeObjects = yield Promise.all(commit.changes.map((_a) => __awaiter(this, [_a], void 0, function* ({ path, mode, status }) { - let sha = null; - if (status === 'A' || status === 'M') { - try { - const { data: blob } = yield blobCreationLimit(() => this.octokit.rest.git.createBlob(Object.assign(Object.assign({}, repository), { content: utils.readFileBase64([repoPath, path]), encoding: 'base64' }))); - sha = blob.sha; - } - catch (error) { - core.error(`Error creating blob for file '${path}': ${utils.getErrorMessage(error)}`); - throw error; + const treeObjects = yield Promise.all(commit.changes.map((_a) => __awaiter(this, [_a], void 0, function* ({ path, mode, status, dstSha }) { + if (mode === '160000') { + // submodule + return { + path, + mode, + sha: dstSha, + type: 'commit' + }; + } + else { + let sha = null; + if (status === 'A' || status === 'M') { + try { + const { data: blob } = yield blobCreationLimit(() => this.octokit.rest.git.createBlob(Object.assign(Object.assign({}, repository), { content: utils.readFileBase64([repoPath, path]), encoding: 'base64' }))); + sha = blob.sha; + core.info(`Created blob for file '${path}'`); + } + catch (error) { + core.error(`Error creating blob for file '${path}': ${utils.getErrorMessage(error)}`); + throw error; + } } + return { + path, + mode, + sha, + type: 'blob' + }; } - core.info(`Created blob for file '${path}'`); - return { - path, - mode, - sha, - type: 'blob' - }; }))); const chunkSize = 100; const chunkedTreeObjects = Array.from({ length: Math.ceil(treeObjects.length / chunkSize) }, (_, i) => treeObjects.slice(i * chunkSize, i * chunkSize + chunkSize)); diff --git a/src/github-helper.ts b/src/github-helper.ts index ff549dbf58..b34df5948d 100644 --- a/src/github-helper.ts +++ b/src/github-helper.ts @@ -35,7 +35,7 @@ type TreeObject = { path: string mode: '100644' | '100755' | '040000' | '160000' | '120000' sha: string | null - type: 'blob' + type: 'blob' | 'commit' } export class GitHubHelper { @@ -255,31 +255,41 @@ export class GitHubHelper { if (commit.changes.length > 0) { core.info(`Creating tree objects for local commit ${commit.sha}`) const treeObjects = await Promise.all( - commit.changes.map(async ({path, mode, status}) => { - let sha: string | null = null - if (status === 'A' || status === 'M') { - try { - const {data: blob} = await blobCreationLimit(() => - this.octokit.rest.git.createBlob({ - ...repository, - content: utils.readFileBase64([repoPath, path]), - encoding: 'base64' - }) - ) - sha = blob.sha - } catch (error) { - core.error( - `Error creating blob for file '${path}': ${utils.getErrorMessage(error)}` - ) - throw error + commit.changes.map(async ({path, mode, status, dstSha}) => { + if (mode === '160000') { + // submodule + return { + path, + mode, + sha: dstSha, + type: 'commit' + } + } else { + let sha: string | null = null + if (status === 'A' || status === 'M') { + try { + const {data: blob} = await blobCreationLimit(() => + this.octokit.rest.git.createBlob({ + ...repository, + content: utils.readFileBase64([repoPath, path]), + encoding: 'base64' + }) + ) + sha = blob.sha + core.info(`Created blob for file '${path}'`) + } catch (error) { + core.error( + `Error creating blob for file '${path}': ${utils.getErrorMessage(error)}` + ) + throw error + } + } + return { + path, + mode, + sha, + type: 'blob' } - } - core.info(`Created blob for file '${path}'`) - return { - path, - mode, - sha, - type: 'blob' } }) ) From 37c6374aa7638e900f2ccb3e81aa15156dd6553b Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:57:56 +0000 Subject: [PATCH 3/3] update log messages --- dist/index.js | 3 ++- src/github-helper.ts | 5 ++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/dist/index.js b/dist/index.js index 4284a52680..5905299db1 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1372,6 +1372,7 @@ class GitHubHelper { const treeObjects = yield Promise.all(commit.changes.map((_a) => __awaiter(this, [_a], void 0, function* ({ path, mode, status, dstSha }) { if (mode === '160000') { // submodule + core.info(`Creating tree object for submodule commit at '${path}'`); return { path, mode, @@ -1385,13 +1386,13 @@ class GitHubHelper { try { const { data: blob } = yield blobCreationLimit(() => this.octokit.rest.git.createBlob(Object.assign(Object.assign({}, repository), { content: utils.readFileBase64([repoPath, path]), encoding: 'base64' }))); sha = blob.sha; - core.info(`Created blob for file '${path}'`); } catch (error) { core.error(`Error creating blob for file '${path}': ${utils.getErrorMessage(error)}`); throw error; } } + core.info(`Creating tree object for blob at '${path}' with status '${status}'`); return { path, mode, diff --git a/src/github-helper.ts b/src/github-helper.ts index b34df5948d..82a9296a21 100644 --- a/src/github-helper.ts +++ b/src/github-helper.ts @@ -258,6 +258,7 @@ export class GitHubHelper { commit.changes.map(async ({path, mode, status, dstSha}) => { if (mode === '160000') { // submodule + core.info(`Creating tree object for submodule commit at '${path}'`) return { path, mode, @@ -276,7 +277,6 @@ export class GitHubHelper { }) ) sha = blob.sha - core.info(`Created blob for file '${path}'`) } catch (error) { core.error( `Error creating blob for file '${path}': ${utils.getErrorMessage(error)}` @@ -284,6 +284,9 @@ export class GitHubHelper { throw error } } + core.info( + `Creating tree object for blob at '${path}' with status '${status}'` + ) return { path, mode,