feat: Allow overriding the base/head names for better Release notes

Author: finger563

README.md

@@ -139,6 +139,8 @@ jobs:
       with:
         app_name: "My ESP-IDF App"
         app_path: "."
+        head_name: "${{ github.event.release.tag_name }}"
+        base_name: "${{ steps.base.outputs.ref }}"
         idf_target: esp32s3
         idf_version: v5.5
         idf_component_manager: "1" # enable component manager
@@ -168,6 +170,14 @@ inputs:
     description: 'Set IDF_COMPONENT_MANAGER ("0" to disable)'
     required: false
     default: '0'
+  head_name:
+    description: 'Name of the head app (for reporting, defaults to "PR")'
+    required: false
+    default: 'PR'
+  base_name:
+    description: 'Name of the base app (for reporting, defaults to "Base")'
+    required: false
+    default: 'Base'
   base_ref:
     description: 'Git ref/sha to use as base for delta (defaults to PR base sha)'
     required: false

action.yml

@@ -20,6 +20,14 @@ inputs:
     description: 'Set IDF_COMPONENT_MANAGER ("0" to disable)'
     required: false
     default: '0'
+  head_name:
+    description: 'Name of the head app (for reporting, defaults to "PR")'
+    required: false
+    default: 'PR'
+  base_name:
+    description: 'Name of the base app (for reporting, defaults to "Base")'
+    required: false
+    default: 'Base'
   base_ref:
     description: 'Git ref/sha to use as base for delta (defaults to PR base sha)'
     required: false
@@ -108,7 +116,7 @@ runs:
       shell: bash
       run: |
         # generate markdown
-        md=$(${{ steps.id_python_313.outputs.python-path }} ${{ github.action_path }}/render_markdown.py --app-name "${{ inputs.app_name }}" --head-json head/${{ inputs.app_path }}/size.json --base-json base/${{ inputs.app_path }}/size.json)
+        md=$(${{ steps.id_python_313.outputs.python-path }} ${{ github.action_path }}/render_markdown.py --app-name "${{ inputs.app_name }}" --base-name "${{ inputs.base_name }}" --head-name "${{ inputs.head_name }}" --head-json head/${{ inputs.app_path }}/size.json --base-json base/${{ inputs.app_path }}/size.json)
         # append to summary and set output
         echo "$md" >> "$GITHUB_STEP_SUMMARY"
         echo "markdown<<EOF" >> $GITHUB_OUTPUT

render_markdown.py

@@ -36,6 +36,8 @@ def fmt_delta(delta: int, delta_pct: Optional[float], precision: int) -> str:
 def main():
     ap = argparse.ArgumentParser(description="Render markdown size table for ESP-IDF app")
     ap.add_argument("--app-name", required=True)
+    ap.add_argument("--base-name", required=False, help="Name of base branch/commit/tag", default="Base")
+    ap.add_argument("--head-name", required=False, help="Name of head branch/commit/tag", default="PR")
     ap.add_argument("--head-json", required=True, help="Path to head size.json")
     ap.add_argument("--base-json", required=True, help="Path to base size.json")
     ap.add_argument("--flash-total-override", type=int, default=0)
@@ -117,7 +119,7 @@ def fmt_row(label: str, key: str, show_pct: bool) -> str:
     md = [
         f"### ESP-IDF Size Report for '{args.app_name}'",
         "",
-        "| Metric | Base | PR | Delta |",
+        f"| Metric | {args.base_name} | {args.head_name} | Delta |",
         "|---|---:|---:|---:|",
         *rows,
         "",