Add git custom hook

DataDog · Feb 21, 2025 · 459a5ed · 459a5ed
1 parent 52560cf
commit 459a5ed
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -131,6 +131,7 @@ export type CustomHooks = {
     init?: HookFn<[GlobalContext]>;
     buildReport?: HookFn<[BuildReport]>;
     bundlerReport?: HookFn<[BundlerReport]>;
+    git?: HookFn<[RepositoryData]>;
 };
 
 export type PluginOptions = Assign<

diff --git a/packages/plugins/git/src/index.ts b/packages/plugins/git/src/index.ts
@@ -30,6 +30,7 @@ export const getGitPlugins = (options: Options, context: GlobalContext): PluginO
                     // Add git information to the context.
                     const repositoryData = await getRepositoryData(await newSimpleGit(context.cwd));
                     context.git = repositoryData;
+                    await context.asyncHook('git', context.git);
                 } catch (e: any) {
                     // We don't want to have the build fail for this.
                     log.error(`Could not get git information: ${e.message}`);

diff --git a/packages/tests/src/unit/plugins/git/index.test.ts b/packages/tests/src/unit/plugins/git/index.test.ts
@@ -51,6 +51,7 @@ describe('Git Plugin', () => {
 
         // Intercept contexts to verify it at the moment they're used.
         const gitReports: Record<string, RepositoryData | undefined> = {};
+        const gitHookReports: Record<string, RepositoryData | undefined> = {};
         // Need to store it here as the mock gets cleared between tests (and beforeAll).
         let nbCallsToGetRepositoryData = 0;
         let cleanup: CleanupFn;
@@ -61,6 +62,16 @@ describe('Git Plugin', () => {
                     // We need sourcemaps to trigger the git plugin.
                     sourcemaps: getSourcemapsConfiguration(),
                 },
+                customPlugins: (opts, context) => {
+                    return [
+                        {
+                            name: 'custom-test-hook-plugin',
+                            git(repoData) {
+                                gitHookReports[context.bundler.fullName] = repoData;
+                            },
+                        },
+                    ];
+                },
             };
 
             uploadSourcemapsMocked.mockImplementation((options, context, log) => {
@@ -84,6 +95,12 @@ describe('Git Plugin', () => {
             expect(nbCallsToGetRepositoryData).toBe(BUNDLERS.length);
         });
 
+        test.each(BUNDLERS)('[$name|$version] Should call the git hook.', async ({ name }) => {
+            const gitReport = gitHookReports[name];
+            expect(gitReport).toBeDefined();
+            expect(gitReport).toMatchObject(mockGitData);
+        });
+
         test.each(BUNDLERS)(
             '[$name|$version] Should add data to the context.',
             async ({ name }) => {