docs: documented isBaseDiffFromHead behavior

pkg-size · Dec 7, 2020 · 20830ca · 20830ca
1 parent fc8c547
commit 20830ca
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/index.js b/src/index.js
@@ -13,8 +13,11 @@ import {rmRF} from '@actions/io';
 
 const COMMENT_SIGNATURE = sub('🤖 This report was automatically generated by [pkg-size-action](https://github.com/privatenumber/pkg-size-action/)');
 
-// TODO: make sure this will work with empty commits or reverted changes
-// TODO: make sure this doesnt consider unstaged files
+/*
+ * Compares files between current ref and the base ref (not commits)
+ * The clean up (git reset --hard) that happens is crucial as it
+ * takes into consideration unstaged files
+ */
 async function isBaseDiffFromHead(baseRef) {
 	try {
 		await exec(`git fetch origin ${baseRef} --depth=1`);