mycroft/descartes-technical-test
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Patrick MARIE 2024-10-08 19:57:39 +02:00
parent c7545c404f
commit 2ad69d5c1e
Signed by: mycroft
GPG Key ID: BB519E5CD8E7BFA7
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -41,11 +41,18 @@ Note that deleted objects are ignored (no file is created). However, to track co
Check `.github/workflows/backup.yaml` for usage sample.
## Tests
A sample test script exists to verify basic use case of backup'ing a limited number of commits. The `scripts/test.sh` runs a couple of backups and run a `diff -r` against a manually verified backup included in the repository. A workflow runs tests on push.
The script is testing a few backups (1, 5, 10) against Descartes Underwriting repository. Then I've created another repository with multiple files in commits to tests a bit more complex commits. I've the feeling this would require more work.
Check `.github/workflows/tests.yaml` for the test workflow.
## Not covered / Improvements ideas
- Keep track of latest commit backuped to allow iterative backups. As for now, the script checks all commits (which is not really efficient); However, if latest commit backup is tracked and this commit to be overwritten by a force push, it will be eventually required to re-do the whole backup.
- Keep commit messages, metadata (commiter, date), so it is possible to rebuild the git repository DAG.