Merge pull request #27 from particle-iot/feature/sc-125817/add-debug-…

…logs-for-auto-version-feature

fix: [sc-125817] Fix auto-version crash for deleted files

AUTO_VERSION.md

@@ -4,6 +4,9 @@
 
 The auto-versioning feature is designed to manage product firmware version numbers in an automated and consistent manner.
 
+It is primarily intended for use in Action workflows that release firmware and upload it to Particle products.
+Here is an [example firmware project](https://github.com/particle-iot/firmware-cicd-examples/tree/main/product-firmware) that has a two GitHub Actions workflows: build and upload.
+
 ## Usage
 
 Auto-versioning is disabled by default. To enable auto-versioning:
@@ -188,3 +191,8 @@ jobs:
 1. Manual Version Changes: If you manually increment the version macro while automatic versioning is enabled, the automatic versioning system may increment the version again.
    It is recommended that you disable automatic versioning if you are going to manually increment the version macro.
 
+
+## Debugging
+
+To debug the auto-versioning feature, you can [re-run a job with debug logging](https://github.blog/changelog/2022-05-24-github-actions-re-run-jobs-with-debug-logging/) enabled.
+This will allow you to see the step-by-step process of how the version number is determined and incremented. 

README.md

@@ -17,7 +17,8 @@ Other Actions for firmware development: Compile | [Flash Device](https://github.
     # Required: true
     particle-platform-name: ''
 
-    # Path to directory with sources to compile
+    # This is your Particle project directory
+    # It contains your source code, libraries, and the project.properties file
     # Required: false
     sources-folder: '.'
 

src/autoversion.test.ts

@@ -19,9 +19,13 @@ jest.mock('fs/promises', () => ({
 
 const warningMock = jest.fn();
 const infoMock = jest.fn();
+const debugMock = jest.fn();
+const errorMock = jest.fn();
 jest.mock('@actions/core', () => ({
 	warning: warningMock,
-	info: infoMock
+	info: infoMock,
+	debug: debugMock,
+	error: errorMock
 }));
 
 import { findProductVersionMacroFile, currentFirmwareVersion } from './git';