The Compare command
Compare 2 git revisions against each other and see the évolution of your debt between them
where GIT_REV is a hash, commit, or a branch where Git is able to checkout onto
This command is useful (and has been thought to do so) to publish Pull request reports. It's mostly designed to run in a CI environment, but you can run it from anywhere
DO NOT ABORT EXECUTION : As Debt Collector will checkout during the execution of this command, you may find yourself in a different git state if you do not let Debt collector run the commnd until completion.
Example :
In this case, debt-collector will compare the "Main" branch with the current head.
Debt-collector require you to have a clean history in order to run this command. All changes need to be committed to the current head. The revision argument should point to an ancestor of the current head. Make sure your local git history is up to date.
The compare command will first check the Main branch, then analyse Diff between the ancestor and current head. And then report for every modified files, the debt score évolution, and provide hints on how to reduce the debt further.
Optional flags :
Last updated