Merge pull request #22012 from manuelfalcon/master

Adding support for removing file from git index

.changeset/brave-shirts-hang.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Adding support for removing file from git index

packages/backend-common/api-report.md

@@ -417,6 +417,7 @@ export class Git {
     force?: boolean;
   }): Promise<PushResult>;
   readCommit(options: { dir: string; sha: string }): Promise<ReadCommitResult>;
+  remove(options: { dir: string; filepath: string }): Promise<void>;
   resolveRef(options: { dir: string; ref: string }): Promise<string>;
 }
 

packages/backend-common/src/scm/git.test.ts

@@ -63,6 +63,22 @@ describe('Git', () => {
     });
   });
 
+  describe('remove', () => {
+    it('should call isomorphic-git remove with the correct arguments', async () => {
+      const git = Git.fromAuth({});
+      const dir = 'mockdirectory';
+      const filepath = 'mockfile/path';
+
+      await git.remove({ dir, filepath });
+
+      expect(isomorphic.remove).toHaveBeenCalledWith({
+        fs,
+        dir,
+        filepath,
+      });
+    });
+  });
+
   describe('deleteRemote', () => {
     it('should call isomorphic-git with the correct arguments', async () => {
       const git = Git.fromAuth({});

packages/backend-common/src/scm/git.ts

@@ -300,6 +300,15 @@ export class Git {
     return git.readCommit({ fs, dir, oid: sha });
   }
 
+  /** https://isomorphic-git.org/docs/en/remove */
+  async remove(options: { dir: string; filepath: string }): Promise<void> {
+    const { dir, filepath } = options;
+    this.config.logger?.info(
+      `Removing file from git index {dir=${dir},filepath=${filepath}}`,
+    );
+    return git.remove({ fs, dir, filepath });
+  }
+
   /** https://isomorphic-git.org/docs/en/resolveRef */
   async resolveRef(options: { dir: string; ref: string }): Promise<string> {
     const { dir, ref } = options;