feat(git): allow to install git-hook functions to local repositories (#…

…19685)
renovatebot · Jan 6, 2023 · 5b4b646 · 5b4b646
1 parent c5f7924
commit 5b4b646
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 0 deletions.
diff --git a/lib/util/git/index.spec.ts b/lib/util/git/index.spec.ts
@@ -1056,4 +1056,30 @@ describe('util/git/index', () => {
       expect(sha).toBe(git.getBranchCommit(defaultBranch));
     });
   });
+
+  describe('installHook()', () => {
+    it('installHook()', async () => {
+      //git.getCommitMessages() only returns the first line (i.e. subject) of each msg
+      await git.installHook(
+        'commit-msg',
+        '#!/bin/sh\necho "APPENDED FROM COMMIT-MSG HOOK" >> $1;'
+      );
+      const files: FileChange[] = [
+        {
+          type: 'addition',
+          path: 'some-new-file',
+          contents: 'some new-contents',
+        },
+      ];
+      setNoVerify(['push']);
+      await git.commitFiles({
+        branchName: 'renovate/something',
+        files,
+        message: 'Orig-commit-msg',
+      });
+
+      const messages = await git.getCommitMessages();
+      expect(messages[0]).toBe('Orig-commit-msg APPENDED FROM COMMIT-MSG HOOK');
+    });
+  });
 });
diff --git a/lib/util/git/index.ts b/lib/util/git/index.ts
@@ -249,6 +249,17 @@ export async function initRepo(args: StorageConfig): Promise<void> {
   await fetchBranchCommits();
 }
 
+export async function installHook(
+  name: string,
+  hookSource: string
+): Promise<void> {
+  await syncGit();
+  const localDir = GlobalConfig.get('localDir')!;
+  const gitHooks = upath.join(localDir, '.git/hooks');
+  await fs.writeFile(`${gitHooks}/${name}`, hookSource);
+  await fs.chmod(`${gitHooks}/${name}`, 0o500);
+}
+
 async function resetToBranch(branchName: string): Promise<void> {
   logger.debug(`resetToBranch(${branchName})`);
   await git.raw(['reset', '--hard']);