feat(GGs): introduce GitFileSystemService as middleman interface - Githubissues

isomerpages / isomercms-backend

A static website builder and host for the Singapore Government

5 stars 1 forks source link

feat(GGs): introduce GitFileSystemService as middleman interface #867

Closed dcshzj closed 1 year ago

dcshzj commented 1 year ago

Problem

Closes IS-320.

Solution

Breaking Changes

[ ] Yes - this PR contains breaking changes
[x] No - this PR is backwards compatible

Features:

This PR introduces a new GitFileSystemService that can interface with the filesystem to perform Git-related operations.
- As an MVP, only reading of files are supported
- Some other functionality are also introduced, such as cloning, pulling, listing files in a directory and getting the Git blob hash

This PR is the first of a 2-part PR. The eventual architecture should look something like this:

IS-320

Tests

Unit tests

Deploy Notes

New environment variables:

EFS_VOL_PATH : The path to the EFS volume used for storing the Git repositories

New dependencies:

simple-git : Wrapper for running Git-related operations on the underlying file system

New dev dependencies:

mock-fs : Provides a mock filesystem when performing unit tests