Fix build folder tree packaging and add exclude-file-glob input (#4)

* print build directory before and after modification to ensure it is correct

* test using collect-system-data-files

* revert back to original

* fix action and how it manages the provided files. add feature to exclude files

* readme: udpate

* update to 1.0.4

Author: finger563

README.md

@@ -16,6 +16,7 @@ For an example repository which uses this action, please see
     - [Required Build Artifacts](#required-build-artifacts)
     - [Optional Build Artifacts](#optional-build-artifacts)
   - [Using this action](#using-this-action)
+    - [Inputs](#inputs)
 
 <!-- markdown-toc end -->
 
@@ -43,7 +44,7 @@ use.
         os: [windows-latest, macos-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: esp-cpp/esp-packaged-programmer-action@v1.0.2
+      - uses: esp-cpp/esp-packaged-programmer-action@v1.0.4
         with:
           zipfile-name: 'your-build-artifacts'
           programmer-name: 'your_programmer_name'
@@ -135,9 +136,38 @@ jobs:
         os: [windows-latest, macos-latest, ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: esp-cpp/esp-packaged-programmer-action@v1.0.2
+      - uses: esp-cpp/esp-packaged-programmer-action@v1.0.4
         with:
           zipfile-id: ${{ needs.build.outputs.zipfile-id }}
           programmer-name: 'your_programmer_name'
+          exclude-file-globs: '*.elf, app-flash_args, bootloader-flash_args, partition-table-flash_args'
 ```
 
+### Inputs
+
+```yaml
+- uses: esp-cpp/download-artifact@v1.0.4
+  with:
+    # The ID of the artifact to download. 
+    # Mutually exclusive with `zipfile-name`. 
+    # The artifact should be a zip that contains the files and folder 
+    # structure of the build output. Can be created by passing relevant 
+    # files to the actions/upload-artifact@v4 action.
+    zipfile-id:
+
+    # The name of the artifact to download. 
+    # Mutually exclusive with `zipfile-name`. 
+    # The artifact should be a zip that contains the files and folder 
+    # structure of the build output. Can be created by passing relevant 
+    # files to the actions/upload-artifact@v4 action.
+    zipfile-name:
+
+    # The base name of the programmer executable. 
+    # Will have version tag (e.g. v1.0.0 or commit hash if no tags) and 
+    # OS suffix (e.g. windows, macos, linux) added to it.
+    programmer-name:
+
+    # Comma-separated list of file names or globs which are present in 
+    # the zipfile but which should be excluded from the packaging. 
+    exclude-file-globs:
+```

action.yml

@@ -2,17 +2,21 @@ name: 'ESP Packaged Programmer'
 description: 'Package esptool and the binaries into an executable'
 inputs:
   zipfile-id:
-    description: 'Artifact ID for the Zipfile to download. Zipfile should contain firmware.bin, bootloader.bin, partition-table.bin, and flasher_args.json. May optionally contain filesystem binaries and associated -flash_args files. NOTE: only one of zipfile-id or zipfile-name should be set.'
+    description: 'Artifact ID for the Zipfile to download. Zipfile should contain firmware.bin, bootloader.bin, partition-table.bin, and flasher_args.json. May optionally contain filesystem binaries and associated -flash_args files. NOTE: only one of zipfile-id or zipfile-name should be set. The structure of the zip should be the same as the build folder within the esp-idf build - so it should have the tree: build/, build/bootloader/, build/partition_table/'
     required: false
     default: ''
   zipfile-name:
-    description: 'Name of the zipfile artifact that was packaged and uploaded. Zipfile should contain firmware.bin, bootloader.bin, partition-table.bin, and flasher_args.json. May optionally contain filesystem binaries and associated -flash_args files. NOTE: only one of zipfile-id or zipfile-name should be set.'
+    description: 'Name of the zipfile artifact that was packaged and uploaded. Zipfile should contain firmware.bin, bootloader.bin, partition-table.bin, and flasher_args.json. May optionally contain filesystem binaries and associated -flash_args files. NOTE: only one of zipfile-id or zipfile-name should be set. The structure of the zip should be the same as the build folder within the esp-idf build - so it should have the tree: build/, build/bootloader/, build/partition_table/'
     required: false
     default: ''
   programmer-name:
     description: 'Base name of the programmer executable. Will have version tag (e.g. v1.0.0 or commit hash if no tags) and OS suffix (e.g. windows, linux, macos) appended.'
     required: false
     default: 'programmer'
+  exclude-file-globs:
+    description: 'File globs to exclude from the build folder. This is a comma-separated list of filenames or globs. For example: "*.elf,*.pdb,app-flash_args". Defaults to "*.elf".'
+    required: false
+    default: '*.elf'
 outputs:
   artifact-name:
     description: "Name of the programmer artifact that was packaged and uploaded"
@@ -76,17 +80,21 @@ runs:
         artifact-ids: ${{ inputs.zipfile-id }}
         path: ${{ github.action_path }}/build
 
-    - name: Move the artifacts to the build directory
+    - name: Remove any unneeded files from the build folder
       shell: bash
+      if: ${{ inputs.exclude-file-globs != '' }}
       working-directory: ${{ github.action_path }}
       run: |
-        # we don't control the name of the unpacked archive (folder) that's
-        # within build/ so simply move everything within that subfolder into
-        # build/
-        find build -maxdepth 2 -mindepth 2 -exec mv {} build/. \;
-        # also, we don't want any elf files if they were uploaded (which they
-        # sometimes are for debug purposes), so delete them
-        find build -name "*.elf" -type f -delete
+        # for each of the file globs in the exclude-file-globs input, remove the
+        # files from the build folder
+        IFS=',' read -ra globs <<< "${{ inputs.exclude-file-globs }}"
+        for glob in "${globs[@]}"; do
+            # remove the leading and trailing spaces
+            glob=$(echo "$glob" | xargs)
+            echo "Cleaning up files matching pattern: $glob"
+            # remove the files from the build folder
+            find build -name "$glob" -exec rm -rf {} \;
+        done
 
     # Build if windows
     - name: PyInstaller

programmer.spec

@@ -1,9 +1,12 @@
 # -*- mode: python ; coding: utf-8 -*-
 
+from PyInstaller.utils.hooks import collect_system_data_files
+
 block_cipher = None
 
 # needed for programming
 added_datas = [
+    ('build', 'build'),
     ('esptool/flasher_stub/*.c', './flasher_stub/'),
     ('esptool/flasher_stub/*.py', './flasher_stub/'),
     ('esptool/flasher_stub/ld/*.ld', './flasher_stub/ld/'),
@@ -39,14 +42,15 @@ a = Analysis(['programmer.py'],
              win_private_assemblies=False,
              cipher=block_cipher,
              noarchive=False)
+
 pyz = PYZ(a.pure, a.zipped_data,
              cipher=block_cipher)
 
 exe = EXE(pyz,
           a.scripts, 
           a.binaries,
           a.zipfiles,
-          a.datas + Tree('build', 'build'),
+          a.datas,
           name='programmer',
           debug=False,
           bootloader_ignore_signals=False,